Bare metal APIv1

Introduction

Bare metal as a service allows ordering a dedicated server on-demand like a cloud instance. Dedicated servers could be used for large workloads, big data, those requiring more security, ….

This is the v1 documentation, the v1alpha1 version is available here.

Technical Limitations

Bare metal is only available in fr-par-2 zone
Installation is done by preseed (± 10min) (preseed: complete install from a virtual media)
The list of OS is limited, you can install your own using the following tutorial: https://www.scaleway.com/en/docs/bare-metal-server-installation-kvm-over-ip/

Features

Install (Server is installed by preseed (preseed: complete install from a virtual media), you must define at least one ssh key to install your server)
Start/Stop/Reboot
Rescue Reboot, a rescue image is an operating system image designed to help you diagnose and fix an OS experiencing failures. When your server boot on rescue, you can mount your disks and start diagnosing/fixing your image.
BMC access: Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it.
Billed by minute (The billing start when the server is delivered and stop when the server is deleted)
IPv6, all servers are available with an IPv6 /128
ReverseIP, You can configure your reverse IP (IPv4 and IPv6), you must register the server IP in your DNS records before calling the endpoint
Basic monitoring with ping status
IP failovers are not available in api v1, use the api v1alpha1

FAQ

How can I get my ssh key id ?

You can find your $SCW_SECRET_KEY and your $SCW_DEFAULT_ORGANIZATION_ID at the following page: https://console.scaleway.com/account/credentials

Servers

A server represents a dedicated baremetal server.

List baremetal servers

List baremetal servers.

GET

/baremetal/v1/zones/{zone}/servers

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

Query Parameters

page

number

Page number. The default value is 1.

page_size

number

Number of server per page. The default value is 20.

order_by

string

Order of the servers. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.

tags

array

Filter servers by tags.

status

array

Filter servers by status.

name

nullable string

Filter servers by name.

organization_id

nullable string

Filter servers by organization ID.

200 Response

total_count

number

Total count of matching servers.

servers

array

Servers that match filters.

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "total_count": 42,
  "servers": [
    {
      "id": "string",
      "organization_id": "string",
      "name": "string",
      "description": "string",
      "updated_at": "string",
      "created_at": "string",
      "status": "unknown",
      "offer_id": "string",
      "tags": [
        "string"
      ],
      "ips": [
        {
          "id": "string",
          "address": "1.2.3.4",
          "reverse": "string",
          "version": "IPv4",
          "reverse_status": "unknown",
          "reverse_status_message": "string"
        }
      ],
      "domain": "string",
      "boot_type": "unknown_boot_type",
      "zone": "string",
      "install": {
        "os_id": "string",
        "hostname": "string",
        "ssh_key_ids": [
          "string"
        ],
        "status": "unknown"
      },
      "ping_status": "ping_status_unknown"
    }
  ]
}

Create a baremetal server

Create a new baremetal server. Once the server is created, you probably want to install an OS.

POST

/baremetal/v1/zones/{zone}/servers

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

Body

offer_id

required string

Offer ID of the new server.

organization_id

required string

Organization ID with which the server will be created.

name

required string

Name of the server (≠hostname).

description

required string

Description associated to the server, max 255 characters.

tags

array

Tags to associate to the server.

install

object

os_id

string

hostname

string

ssh_key_ids

array

Request Example

{
  "offer_id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ]
  }
}

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

Get a specific baremetal server

Get the server associated with the given ID.

GET

/baremetal/v1/zones/{zone}/servers/{server_id}

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server.

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

Update a baremetal server

Update the server associated with the given ID.

PATCH

/baremetal/v1/zones/{zone}/servers/{server_id}

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server to update.

Body

name

nullable string

Name of the server (≠hostname), not updated if null.

description

nullable string

Description associated to the server, max 255 characters, not updated if null.

tags

nullable array

Tags associated to the server, not updated if null.

Request Example

{
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ]
}

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

Delete a baremetal server

Delete the server associated with the given ID.

DELETE

/baremetal/v1/zones/{zone}/servers/{server_id}

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server to delete.

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

List server events

List events associated to the given server ID.

GET

/baremetal/v1/zones/{zone}/servers/{server_id}/events

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server events searched.

Query Parameters

page

number

Page number. The default value is 1.

page_size

number

Number of server events per page. The default value is 20.

order_by

string

Order of the server events. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.

200 Response

total_count

number

Total count of matching events.

events

array

Server events that match filters.

string

ID of the server for whom the action will be applied.

action

string

The action that will be applied to the server.

updated_at

string

Date of last modification of the action.

created_at

string

Date of creation of the action.

Response Example

{
  "total_count": 42,
  "events": [
    {
      "id": "string",
      "action": "string",
      "updated_at": "string",
      "created_at": "string"
    }
  ]
}

Install a baremetal server

Install an OS on the server associated with the given ID.

POST

/baremetal/v1/zones/{zone}/servers/{server_id}/install

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

Server ID to install.

Body

os_id

required string

ID of the OS to install on the server.

hostname

required string

Hostname of the server.

ssh_key_ids

required array

SSH key IDs authorized on the server.

Request Example

{
  "os_id": "string",
  "hostname": "string",
  "ssh_key_ids": [
    "string"
  ]
}

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

Update IP

Configure ip associated with the given server ID and ipID. You can use this method to set a reverse dns for an IP.

PATCH

/baremetal/v1/zones/{zone}/servers/{server_id}/ips/{ip_id}

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server.

ip_id

required string

ID of the IP to update.

Body

reverse

nullable string

New reverse IP to update, not updated if null.

Request Example

{
  "reverse": "string"
}

200 Response

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

Response Example

{
  "id": "string",
  "address": "1.2.3.4",
  "reverse": "string",
  "version": "IPv4",
  "reverse_status": "unknown",
  "reverse_status_message": "string"
}

Return server metrics

Give the ping status on the server associated with the given ID.

GET

/baremetal/v1/zones/{zone}/servers/{server_id}/metrics

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

Server ID to get the metrics.

200 Response

pings

object

Timeseries of ping on the server.

name

string

points

array

metadata

map

string

Response Example

{
  "pings": {
    "name": "string",
    "points": [
      [
        null
      ]
    ],
    "metadata": {
      "<metadataKey>": "string"
    }
  }
}

Servers Actions

Server actions allows you to start, stop or reboot your servers.

Reboot a baremetal server

Reboot the server associated with the given ID, use boot param to reboot in rescue.

POST

/baremetal/v1/zones/{zone}/servers/{server_id}/reboot

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server to reboot.

Body

boot_type

string

The type of boot. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

Request Example

{
  "boot_type": "unknown_boot_type"
}

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

Start a baremetal server

Start the server associated with the given ID.

POST

/baremetal/v1/zones/{zone}/servers/{server_id}/start

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server to start.

Body

boot_type

string

The type of boot. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

Request Example

{
  "boot_type": "unknown_boot_type"
}

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

Stop a baremetal server

Stop the server associated with the given ID.

POST

/baremetal/v1/zones/{zone}/servers/{server_id}/stop

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server to stop.

Body

Request Example

{}

200 Response

string

ID of the server.

organization_id

string

Organization ID the server is attached to.

name

string

Name of the server.

description

string

Description of the server.

updated_at

string

Date of last modification of the server.

created_at

string

Date of creation of the server.

status

string

Status of the server. Possible values are unknown, delivering, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.

offer_id

string

Offer ID of the server.

tags

array

Array of customs tags attached to the server.

ips

array

Array of IPs attached to the server.

string

ID of the IP.

address

string

Address of the IP (IP address).

reverse

string

Reverse IP value.

version

string

Version of IP (v4 or v6). Possible values are IPv4 and IPv6. The default value is IPv4.

reverse_status

string

Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.

reverse_status_message

string

A message related to the reverse status, in case of an error for example.

domain

string

Domain of the server.

boot_type

string

Boot type of the server. Possible values are unknown_boot_type, normal and rescue. The default value is unknown_boot_type.

zone

string

The zone in which is the server.

install

object

Configuration of installation.

os_id

string

hostname

string

ssh_key_ids

array

status

string

Possible values are unknown, to_install, installing, completed and error. The default value is unknown.

ping_status

string

Server status of ping. Possible values are ping_status_unknown, ping_status_up and ping_status_down. The default value is ping_status_unknown.

Response Example

{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "1.2.3.4",
      "reverse": "string",
      "version": "IPv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "unknown_boot_type",
  "zone": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "ping_status": "ping_status_unknown"
}

BMC (Baseboard Management Controller) access allow you to access serie console of your baremetal server. The BMC (Baseboard Management Controller) access feature is available one hour after the installation of the server.

Get BMC (Baseboard Management Controller) access for a given baremetal server

Get the BMC (Baseboard Management Controller) access associated with the given ID.

GET

/baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server.

200 Response

url

string

URL to access to the server console.

password

string

The password to use for the BMC (Baseboard Management Controller) access authentification.

expires_at

string

The date after which the BMC (Baseboard Management Controller) access will be closed.

Response Example

{
  "url": "string",
  "login": "string",
  "password": "string",
  "expires_at": "string"
}

Start BMC (Baseboard Management Controller) access for a given baremetal server

Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.

POST

/baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server.

Body

required string

The IP authorized to connect to the given server (IPv4 address).

Request Example

{
  "ip": "1.2.3.4"
}

200 Response

url

string

URL to access to the server console.

password

string

The password to use for the BMC (Baseboard Management Controller) access authentification.

expires_at

string

The date after which the BMC (Baseboard Management Controller) access will be closed.

Response Example

{
  "url": "string",
  "login": "string",
  "password": "string",
  "expires_at": "string"
}

Stop BMC (Baseboard Management Controller) access for a given baremetal server

Stop BMC (Baseboard Management Controller) access associated with the given ID.

DELETE

/baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

server_id

required string

ID of the server.

204 Response

Empty response

Offers

List offers

List all available server offers.

GET

/baremetal/v1/zones/{zone}/offers

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

Query Parameters

page

number

Page number. The default value is 1.

page_size

number

Number of offers per page. The default value is 20.

200 Response

total_count

number

Total count of matching offers.

offers

array

Offers that match filters.

string

ID of the offer.

name

string

Name of the offer.

stock

string

Stock level. Possible values are empty, low and available. The default value is empty.

bandwidth

number

Bandwidth available in bits/s with the offer.

commercial_range

string

Commercial range of the offer.

price_per_hour

object

Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).

currency_code

string

units

number

nanos

number

price_per_month

object

Price of the offer per months.

currency_code

string

units

number

nanos

number

disks

array

Disks specifications of the offer.

capacity

number

Capacity of the disk in bytes (in bytes).

type

string

Type of the disk.

enable

boolean

True if the offer is currently available.

cpus

array

CPU specifications of the offer.

name

string

Name of the CPU.

core_count

number

Number of cores of the CPU.

thread_count

number

Number of threads of the CPU.

frequency

number

memories

array

Memory specifications of the offer.

capacity

number

(in bytes).

type

string

frequency

number

is_ecc

boolean

quota_name

string

Name of the quota associated to the offer.

persistent_memories

array

Persistent memory specifications of the offer.

capacity

number

(in bytes).

type

string

frequency

number

raid_controllers

array

Raid controller specifications of the offer.

model

string

raid_level

array

Response Example

{
  "total_count": 42,
  "offers": [
    {
      "id": "string",
      "name": "string",
      "stock": "empty",
      "bandwidth": 42,
      "commercial_range": "string",
      "price_per_hour": {
        "currency_code": "string",
        "units": 42,
        "nanos": 42
      },
      "price_per_month": {
        "currency_code": "string",
        "units": 42,
        "nanos": 42
      },
      "disks": [
        {
          "capacity": 42,
          "type": "string"
        }
      ],
      "enable": "boolean",
      "cpus": [
        {
          "name": "string",
          "core_count": 42,
          "thread_count": 42,
          "frequency": 42
        }
      ],
      "memories": [
        {
          "capacity": 42,
          "type": "string",
          "frequency": 42,
          "is_ecc": "boolean"
        }
      ],
      "quota_name": "string",
      "persistent_memories": [
        {
          "capacity": 42,
          "type": "string",
          "frequency": 42
        }
      ],
      "raid_controllers": [
        {
          "model": "string",
          "raid_level": [
            "string"
          ]
        }
      ]
    }
  ]
}

Get offer

Return specific offer for the given ID.

GET

/baremetal/v1/zones/{zone}/offers/{offer_id}

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

offer_id

required string

ID of the researched Offer.

200 Response

string

ID of the offer.

name

string

Name of the offer.

stock

string

Stock level. Possible values are empty, low and available. The default value is empty.

bandwidth

number

Bandwidth available in bits/s with the offer.

commercial_range

string

Commercial range of the offer.

price_per_hour

object

Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).

currency_code

string

units

number

nanos

number

price_per_month

object

Price of the offer per months.

currency_code

string

units

number

nanos

number

disks

array

Disks specifications of the offer.

capacity

number

Capacity of the disk in bytes (in bytes).

type

string

Type of the disk.

enable

boolean

True if the offer is currently available.

cpus

array

CPU specifications of the offer.

name

string

Name of the CPU.

core_count

number

Number of cores of the CPU.

thread_count

number

Number of threads of the CPU.

frequency

number

memories

array

Memory specifications of the offer.

capacity

number

(in bytes).

type

string

frequency

number

is_ecc

boolean

quota_name

string

Name of the quota associated to the offer.

persistent_memories

array

Persistent memory specifications of the offer.

capacity

number

(in bytes).

type

string

frequency

number

raid_controllers

array

Raid controller specifications of the offer.

model

string

raid_level

array

Response Example

{
  "id": "string",
  "name": "string",
  "stock": "empty",
  "bandwidth": 42,
  "commercial_range": "string",
  "price_per_hour": {
    "currency_code": "string",
    "units": 42,
    "nanos": 42
  },
  "price_per_month": {
    "currency_code": "string",
    "units": 42,
    "nanos": 42
  },
  "disks": [
    {
      "capacity": 42,
      "type": "string"
    }
  ],
  "enable": "boolean",
  "cpus": [
    {
      "name": "string",
      "core_count": 42,
      "thread_count": 42,
      "frequency": 42
    }
  ],
  "memories": [
    {
      "capacity": 42,
      "type": "string",
      "frequency": 42,
      "is_ecc": "boolean"
    }
  ],
  "quota_name": "string",
  "persistent_memories": [
    {
      "capacity": 42,
      "type": "string",
      "frequency": 42
    }
  ],
  "raid_controllers": [
    {
      "model": "string",
      "raid_level": [
        "string"
      ]
    }
  ]
}

OS

List all available OS that can be install on a baremetal server

List all available OS that can be install on a baremetal server.

GET

/baremetal/v1/zones/{zone}/os

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

Query Parameters

page

number

Page number. The default value is 1.

page_size

number

Number of OS per page. The default value is 20.

offer_id

nullable string

Filter OS by offer ID.

200 Response

total_count

number

Total count of matching OS.

array

OS that match filters.

string

ID of the OS.

name

string

Name of the OS.

version

string

Version of the OS.

Response Example

{
  "total_count": 42,
  "os": [
    {
      "id": "string",
      "name": "string",
      "version": "string"
    }
  ]
}

Get an OS with a given ID

Return specific OS for the given ID.

GET

/baremetal/v1/zones/{zone}/os/{os_id}

Path Parameters

zone

required string

The zone you want to target. Possible value is fr-par-2.

os_id

required string

ID of the OS.

200 Response

string

ID of the OS.

name

string

Name of the OS.

version

string

Version of the OS.

Response Example

{
  "id": "string",
  "name": "string",
  "version": "string"
}