Instance APIv1

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"
    }
  ]
}

Pagination

Most of listing requests receive a paginated response.

Paginated request

Requests against paginated endpoints accept two query arguments:

page, a positive integer to choose the page to display.
per_page, an positive integer lower or equal to 100 to select the number of items to display.

Paginated endpoints usually also accept filters to search and sort results. These filters are documented along each endpoint documentation.

Paginated response

% curl -H 'X-Auth-Token: <token>' 'https://api.scaleway.com/instance/v1/zones/fr-par-1/images/?page=2&per_page=10' -i
HTTP/1.0 200 OK
[...]
X-Total-Count: 209
[...]

The X-Total-Count header contains the total number of items for the resource.

Servers

List 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

organization

nullable string

per_page

nullable number

page

number

Page number. The default value is 1.

name

nullable string

200 Response

servers

array

string

Display the server unique ID.

name

string

Display the server name.

organization

string

Display the server organization.

allowed_actions

array

Provide as list of allowed actions on the server.

tags

array

Display the server associated tags.

commercial_type

string

Display the server commercial type (e.g. GP1-M).

creation_date

string

Display the server creation date.

dynamic_ip_required

boolean

Display if a dynamic IP is required.

enable_ipv6

boolean

Display if IPv6 is enabled.

extra_networks

array

Display information about additional network interfaces.

hostname

string

Display the server host name.

image

object

Provide information on the server image.

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

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

from_server

object

string

name

string

organization

string

public

boolean

root_volume

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

state

string

Possible values are available, creating and error. The default value is available.

protected

boolean

Display the server protection option is activated.

private_ip

nullable string

Display the server private IP address.

public_ip

object

Display the server public IP address.

string

Display the unique ID of the IP address.

address

string

Display the server public IPv4 IP-Address.

dynamic

boolean

Display information if the IP address will be considered as dynamic.

modification_date

string

Display the server modification date.

state

string

Display the server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.

location

object

Display the server location.

cluster_id

string

hypervisor_id

string

node_id

string

platform_id

string

zone_id

string

ipv6

object

Display the server IPv6 address.

address

string

Display the server IPv6 IP-Address.

gateway

string

Display the IPv6 IP-addresses gateway.

netmask

string

Display the IPv6 IP-addresses CIDR netmask.

bootscript

object

Display the server bootscript.

bootcmdargs

string

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

boot_type

string

Display the server boot type. Possible value is local. The default value is local.

volumes

map

Display the server volumes.

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

security_group

object

Display the server security group.

string

name

string

maintenances

array

Display the server planned maintenances.

state_detail

string

Display the server state_detail.

arch

string

Display the server arch. Possible values are x86_64 and arm. The default value is x86_64.

compute_cluster

object

Display the server ComputeCluster.

string

Display compute-cluster unique ID.

name

string

Display compute-cluster name.

organization

string

Display compute-cluster organization.

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 compute-cluster, either low_latency (group) or max_availability (spread). Possible values are low_latency and max_availability. The default value is low_latency.

policy_respected

boolean

Indicate if the selected policy is respected. Returns true if the policy is respected, false otherwise.

total_count

number

Response Example

{
  "servers": [
    {
      "id": "string",
      "name": "string",
      "organization": "string",
      "allowed_actions": [
        "poweron"
      ],
      "tags": [
        "string"
      ],
      "commercial_type": "string",
      "creation_date": "string",
      "dynamic_ip_required": "boolean",
      "enable_ipv6": "boolean",
      "extra_networks": [
        "string"
      ],
      "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",
          "public": "boolean",
          "title": "string",
          "arch": "x86_64"
        },
        "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",
            "server": {
              "id": "string",
              "name": "string"
            },
            "state": "available"
          }
        },
        "from_server": {
          "id": "string",
          "name": "string"
        },
        "organization": "string",
        "public": "boolean",
        "root_volume": {
          "id": "string",
          "name": "string",
          "size": 42,
          "volume_type": "l_ssd",
          "organization": "string"
        },
        "state": "available"
      },
      "protected": "boolean",
      "private_ip": "string",
      "public_ip": {
        "id": "string",
        "address": "string",
        "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": "string",
        "gateway": "string",
        "netmask": "string"
      },
      "bootscript": {
        "bootcmdargs": "string",
        "default": "boolean",
        "dtb": "string",
        "id": "string",
        "initrd": "string",
        "kernel": "string",
        "organization": "string",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64"
      },
      "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",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available"
        }
      },
      "security_group": {
        "id": "string",
        "name": "string"
      },
      "maintenances": [
        {}
      ],
      "state_detail": "string",
      "arch": "x86_64",
      "compute_cluster": {
        "id": "string",
        "name": "string",
        "organization": "string",
        "policy_mode": "optional",
        "policy_type": "low_latency",
        "policy_respected": "boolean"
      }
    }
  ],
  "total_count": 42
}

Create 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

string

Display the server name.

dynamic_ip_required

nullable boolean

Define if a dynamic IP is required for the instance.

commercial_type

string

Define the server commercial type (i.e. GP1-S).

image

string

Define the server image id.

volumes

map

Define the volumes attached to the server.

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

enable_ipv6

boolean

Define if IPv6 is enabled on the server.

public_ip

string

Define the public IPv4 attached to the server.

boot_type

string

Define the boot type you want to use. Possible value is local. The default value is local.

organization

string

Define the server organization.

tags

array

Define the server tags.

security_group

string

Define the security group id.

compute_cluster

string

ComputeCluster key if server must be part of a ComputeCluster.

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"
    }
  },
  "enable_ipv6": "boolean",
  "public_ip": "string",
  "boot_type": "local",
  "organization": "string",
  "tags": [
    "string"
  ],
  "security_group": "string",
  "compute_cluster": "string"
}

201 Response

server

object

string

Display the server unique ID.

name

string

Display the server name.

organization

string

Display the server organization.

allowed_actions

array

Provide as list of allowed actions on the server.

tags

array

Display the server associated tags.

commercial_type

string

Display the server commercial type (e.g. GP1-M).

creation_date

string

Display the server creation date.

dynamic_ip_required

boolean

Display if a dynamic IP is required.

enable_ipv6

boolean

Display if IPv6 is enabled.

extra_networks

array

Display information about additional network interfaces.

hostname

string

Display the server host name.

image

object

Provide information on the server image.

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

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

from_server

object

string

name

string

organization

string

public

boolean

root_volume

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

state

string

Possible values are available, creating and error. The default value is available.

protected

boolean

Display the server protection option is activated.

private_ip

nullable string

Display the server private IP address.

public_ip

object

Display the server public IP address.

string

Display the unique ID of the IP address.

address

string

Display the server public IPv4 IP-Address.

dynamic

boolean

Display information if the IP address will be considered as dynamic.

modification_date

string

Display the server modification date.

state

string

Display the server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.

location

object

Display the server location.

cluster_id

string

hypervisor_id

string

node_id

string

platform_id

string

zone_id

string

ipv6

object

Display the server IPv6 address.

address

string

Display the server IPv6 IP-Address.

gateway

string

Display the IPv6 IP-addresses gateway.

netmask

string

Display the IPv6 IP-addresses CIDR netmask.

bootscript

object

Display the server bootscript.

bootcmdargs

string

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

boot_type

string

Display the server boot type. Possible value is local. The default value is local.

volumes

map

Display the server volumes.

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

security_group

object

Display the server security group.

string

name

string

maintenances

array

Display the server planned maintenances.

state_detail

string

Display the server state_detail.

arch

string

Display the server arch. Possible values are x86_64 and arm. The default value is x86_64.

compute_cluster

object

Display the server ComputeCluster.

string

Display compute-cluster unique ID.

name

string

Display compute-cluster name.

organization

string

Display compute-cluster organization.

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 compute-cluster, either low_latency (group) or max_availability (spread). Possible values are low_latency and max_availability. The default value is low_latency.

policy_respected

boolean

Indicate if the selected policy is respected. Returns true if the policy is respected, false otherwise.

Response Example

{
  "server": {
    "id": "string",
    "name": "string",
    "organization": "string",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "string",
    "creation_date": "string",
    "dynamic_ip_required": "boolean",
    "enable_ipv6": "boolean",
    "extra_networks": [
      "string"
    ],
    "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",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64"
      },
      "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",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available"
        }
      },
      "from_server": {
        "id": "string",
        "name": "string"
      },
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "organization": "string"
      },
      "state": "available"
    },
    "protected": "boolean",
    "private_ip": "string",
    "public_ip": {
      "id": "string",
      "address": "string",
      "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": "string",
      "gateway": "string",
      "netmask": "string"
    },
    "bootscript": {
      "bootcmdargs": "string",
      "default": "boolean",
      "dtb": "string",
      "id": "string",
      "initrd": "string",
      "kernel": "string",
      "organization": "string",
      "public": "boolean",
      "title": "string",
      "arch": "x86_64"
    },
    "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",
        "server": {
          "id": "string",
          "name": "string"
        },
        "state": "available"
      }
    },
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "maintenances": [
      {}
    ],
    "state_detail": "string",
    "arch": "x86_64",
    "compute_cluster": {
      "id": "string",
      "name": "string",
      "organization": "string",
      "policy_mode": "optional",
      "policy_type": "low_latency",
      "policy_respected": "boolean"
    }
  }
}

Get 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

200 Response

server

object

string

Display the server unique ID.

name

string

Display the server name.

organization

string

Display the server organization.

allowed_actions

array

Provide as list of allowed actions on the server.

tags

array

Display the server associated tags.

commercial_type

string

Display the server commercial type (e.g. GP1-M).

creation_date

string

Display the server creation date.

dynamic_ip_required

boolean

Display if a dynamic IP is required.

enable_ipv6

boolean

Display if IPv6 is enabled.

extra_networks

array

Display information about additional network interfaces.

hostname

string

Display the server host name.

image

object

Provide information on the server image.

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

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

from_server

object

string

name

string

organization

string

public

boolean

root_volume

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

state

string

Possible values are available, creating and error. The default value is available.

protected

boolean

Display the server protection option is activated.

private_ip

nullable string

Display the server private IP address.

public_ip

object

Display the server public IP address.

string

Display the unique ID of the IP address.

address

string

Display the server public IPv4 IP-Address.

dynamic

boolean

Display information if the IP address will be considered as dynamic.

modification_date

string

Display the server modification date.

state

string

Display the server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.

location

object

Display the server location.

cluster_id

string

hypervisor_id

string

node_id

string

platform_id

string

zone_id

string

ipv6

object

Display the server IPv6 address.

address

string

Display the server IPv6 IP-Address.

gateway

string

Display the IPv6 IP-addresses gateway.

netmask

string

Display the IPv6 IP-addresses CIDR netmask.

bootscript

object

Display the server bootscript.

bootcmdargs

string

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

boot_type

string

Display the server boot type. Possible value is local. The default value is local.

volumes

map

Display the server volumes.

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

security_group

object

Display the server security group.

string

name

string

maintenances

array

Display the server planned maintenances.

state_detail

string

Display the server state_detail.

arch

string

Display the server arch. Possible values are x86_64 and arm. The default value is x86_64.

compute_cluster

object

Display the server ComputeCluster.

string

Display compute-cluster unique ID.

name

string

Display compute-cluster name.

organization

string

Display compute-cluster organization.

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 compute-cluster, either low_latency (group) or max_availability (spread). Possible values are low_latency and max_availability. The default value is low_latency.

policy_respected

boolean

Indicate if the selected policy is respected. Returns true if the policy is respected, false otherwise.

Response Example

{
  "server": {
    "id": "string",
    "name": "string",
    "organization": "string",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "string",
    "creation_date": "string",
    "dynamic_ip_required": "boolean",
    "enable_ipv6": "boolean",
    "extra_networks": [
      "string"
    ],
    "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",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64"
      },
      "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",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available"
        }
      },
      "from_server": {
        "id": "string",
        "name": "string"
      },
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "organization": "string"
      },
      "state": "available"
    },
    "protected": "boolean",
    "private_ip": "string",
    "public_ip": {
      "id": "string",
      "address": "string",
      "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": "string",
      "gateway": "string",
      "netmask": "string"
    },
    "bootscript": {
      "bootcmdargs": "string",
      "default": "boolean",
      "dtb": "string",
      "id": "string",
      "initrd": "string",
      "kernel": "string",
      "organization": "string",
      "public": "boolean",
      "title": "string",
      "arch": "x86_64"
    },
    "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",
        "server": {
          "id": "string",
          "name": "string"
        },
        "state": "available"
      }
    },
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "maintenances": [
      {}
    ],
    "state_detail": "string",
    "arch": "x86_64",
    "compute_cluster": {
      "id": "string",
      "name": "string",
      "organization": "string",
      "policy_mode": "optional",
      "policy_type": "low_latency",
      "policy_respected": "boolean"
    }
  }
}

Update 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

Body

name

nullable string

boot_type

string

Possible value is local. The default value is local.

tags

nullable array

volumes

map

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

bootscript

object

bootcmdargs

string

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

dynamic_ip_required

nullable boolean

enable_ipv6

nullable boolean

extra_networks

nullable array

protected

nullable boolean

security_group

object

string

name

string

compute_cluster

nullable string

Request Example

{
  "name": "string",
  "boot_type": "local",
  "tags": [
    "string"
  ],
  "volumes": {
    "<volumeKey>": {
      "id": "string",
      "name": "string",
      "size": 42,
      "volume_type": "l_ssd",
      "organization": "string"
    }
  },
  "bootscript": {
    "bootcmdargs": "string",
    "default": "boolean",
    "dtb": "string",
    "id": "string",
    "initrd": "string",
    "kernel": "string",
    "organization": "string",
    "public": "boolean",
    "title": "string",
    "arch": "x86_64"
  },
  "dynamic_ip_required": "boolean",
  "enable_ipv6": "boolean",
  "extra_networks": [
    "string"
  ],
  "protected": "boolean",
  "security_group": {
    "id": "string",
    "name": "string"
  },
  "compute_cluster": "string"
}

200 Response

server

object

string

Display the server unique ID.

name

string

Display the server name.

organization

string

Display the server organization.

allowed_actions

array

Provide as list of allowed actions on the server.

tags

array

Display the server associated tags.

commercial_type

string

Display the server commercial type (e.g. GP1-M).

creation_date

string

Display the server creation date.

dynamic_ip_required

boolean

Display if a dynamic IP is required.

enable_ipv6

boolean

Display if IPv6 is enabled.

extra_networks

array

Display information about additional network interfaces.

hostname

string

Display the server host name.

image

object

Provide information on the server image.

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

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

from_server

object

string

name

string

organization

string

public

boolean

root_volume

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

state

string

Possible values are available, creating and error. The default value is available.

protected

boolean

Display the server protection option is activated.

private_ip

nullable string

Display the server private IP address.

public_ip

object

Display the server public IP address.

string

Display the unique ID of the IP address.

address

string

Display the server public IPv4 IP-Address.

dynamic

boolean

Display information if the IP address will be considered as dynamic.

modification_date

string

Display the server modification date.

state

string

Display the server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.

location

object

Display the server location.

cluster_id

string

hypervisor_id

string

node_id

string

platform_id

string

zone_id

string

ipv6

object

Display the server IPv6 address.

address

string

Display the server IPv6 IP-Address.

gateway

string

Display the IPv6 IP-addresses gateway.

netmask

string

Display the IPv6 IP-addresses CIDR netmask.

bootscript

object

Display the server bootscript.

bootcmdargs

string

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

boot_type

string

Display the server boot type. Possible value is local. The default value is local.

volumes

map

Display the server volumes.

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

security_group

object

Display the server security group.

string

name

string

maintenances

array

Display the server planned maintenances.

state_detail

string

Display the server state_detail.

arch

string

Display the server arch. Possible values are x86_64 and arm. The default value is x86_64.

compute_cluster

object

Display the server ComputeCluster.

string

Display compute-cluster unique ID.

name

string

Display compute-cluster name.

organization

string

Display compute-cluster organization.

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 compute-cluster, either low_latency (group) or max_availability (spread). Possible values are low_latency and max_availability. The default value is low_latency.

policy_respected

boolean

Indicate if the selected policy is respected. Returns true if the policy is respected, false otherwise.

Response Example

{
  "server": {
    "id": "string",
    "name": "string",
    "organization": "string",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "string",
    "creation_date": "string",
    "dynamic_ip_required": "boolean",
    "enable_ipv6": "boolean",
    "extra_networks": [
      "string"
    ],
    "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",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64"
      },
      "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",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available"
        }
      },
      "from_server": {
        "id": "string",
        "name": "string"
      },
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "organization": "string"
      },
      "state": "available"
    },
    "protected": "boolean",
    "private_ip": "string",
    "public_ip": {
      "id": "string",
      "address": "string",
      "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": "string",
      "gateway": "string",
      "netmask": "string"
    },
    "bootscript": {
      "bootcmdargs": "string",
      "default": "boolean",
      "dtb": "string",
      "id": "string",
      "initrd": "string",
      "kernel": "string",
      "organization": "string",
      "public": "boolean",
      "title": "string",
      "arch": "x86_64"
    },
    "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",
        "server": {
          "id": "string",
          "name": "string"
        },
        "state": "available"
      }
    },
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "maintenances": [
      {}
    ],
    "state_detail": "string",
    "arch": "x86_64",
    "compute_cluster": {
      "id": "string",
      "name": "string",
      "organization": "string",
      "policy_mode": "optional",
      "policy_type": "low_latency",
      "policy_respected": "boolean"
    }
  }
}

Delete 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

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

Body

action

string

Possible values are poweron, backup, stop_in_place, poweroff, terminate and reboot. The default value is poweron.

Request Example

{
  "action": "poweron"
}

200 Response

task

object

string

The unique ID of the task.

description

string

The description of the task.

progress

number

Show the progress of the task in percent.

started_at

string

Display the task start date.

terminated_at

string

Display the task end date.

status

string

Display the task status. Possible values are pending, started, success, failure and retry. The default value is pending.

href_from

string

href_result

string

Response Example

{
  "task": {
    "id": "string",
    "description": "string",
    "progress": 42,
    "started_at": "string",
    "terminated_at": "string",
    "status": "pending",
    "href_from": "string",
    "href_result": "string"
  }
}

Images

List 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

boolean

arch

nullable string

200 Response

images

array

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

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

from_server

object

string

name

string

organization

string

public

boolean

root_volume

object

string

Display the volumes unique ID.

name

string

Display the volumes name.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

organization

string

The organization ID.

state

string

Possible values are available, creating and error. The default value is available.

total_count

number

Response Example

{
  "images": [
    {
      "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",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64"
      },
      "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",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available"
        }
      },
      "from_server": {
        "id": "string",
        "name": "string"
      },
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "organization": "string"
      },
      "state": "available"
    }
  ],
  "total_count": 42
}

Create image

POST

/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.

Body

name

string

root_volume

string

arch

string

Possible values are x86_64 and arm. The default value is x86_64.

default_bootscript

object

bootcmdargs

string

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object

string

Display the volumes unique ID.

name

string

Display the volumes names.

export_uri

string

Show the volumes NBD export URI.

size

number

Display the volumes disk size.

volume_type

string

Display the volumes type. Possible values are l_ssd, l_hdd and b_ssd. The default value is l_ssd.

creation_date

string

Display the volumes creation date.

modification_date

string

Display the volumes modification date.

organization

string

Display the volumes organization.

server

object

Display information about the server attached to the volume.

string

name

string

state

string

Display the volumes state. Possible values are available, snapshotting and error. The default value is available.

organization

string

public

boolean

Request Example

{
  "name": "string",
  "root_volume": "string",
  "arch": "x86_64",
  "default_bootscript": {
    "bootcmdargs": "string",
    "default": "boolean",
    "dtb": "string",
    "id": "string",
    "initrd": "string",
    "kernel": "string",
    "organization": "string",
    "public": "boolean",
    "title": "string",
    "arch": "x86_64"
  },
  "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",
      "server": {
        "id": "string",
        "name": "string"
      },
      "state": "available"
    }
  },
  "organization": "string",
  "public": "boolean"
}

201 Response

image

object

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

Display the bootscript parameters.

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.

string

Display the bootscripts ID.

initrd

string

Display the initrd (initial ramdisk) configuration.

kernel

string

Display the server kernel version.

organization

string

Display the bootscripts organization.

public

boolean

Provide information if the bootscript is public.

title

string

Display the bootscripts title.

arch

string

Display the bootscripts arch. Possible values are x86_64 and arm. The default value is x86_64.

extra_volumes

map

<extra_volumeKey>

object