Bare metal APIv1alpha1

Download OpenAPI

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, ….

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)

  • 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, manage its : attach, detach, generate mac, reverse

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 dedictaed baremetal server.

List servers

List all created servers.

GET
/baremetal/v1alpha1/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.
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
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",
      "install": {
        "os_id": "string",
        "hostname": "string",
        "ssh_key_ids": [
          "string"
        ],
        "status": "unknown"
      },
      "tags": [
        "string"
      ],
      "ips": [
        {
          "id": "string",
          "address": "string",
          "reverse": "string",
          "version": "Ipv4",
          "reverse_status": "unknown",
          "reverse_status_message": "string"
        }
      ],
      "domain": "string",
      "boot_type": "normal",
      "zone": "string"
    }
  ]
}

Create server

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

POST
/baremetal/v1alpha1/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.
Request Example
{
  "offer_id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ]
}
200 Response
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

Get server

Get the server associated with the given ID.

GET
/baremetal/v1alpha1/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
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

Update server

Update the server associated with the given ID.

PATCH
/baremetal/v1alpha1/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
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

Delete server

Delete the server associated with the given ID.

DELETE
/baremetal/v1alpha1/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
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

List server events

List events associated to the given server ID.

GET
/baremetal/v1alpha1/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.
event
array
Server events that match filters.
id
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,
  "event": [
    {
      "id": "string",
      "action": "string",
      "updated_at": "string",
      "created_at": "string"
    }
  ]
}

Install server

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

POST
/baremetal/v1alpha1/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
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

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/v1alpha1/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
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable string
A message related to the reverse status, in case of an error for example.
Response Example
{
  "id": "string",
  "address": "string",
  "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/v1alpha1/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
<metadataKey>
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 server

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

POST
/baremetal/v1alpha1/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 normal and rescue. The default value is normal.
Request Example
{
  "boot_type": "normal"
}
200 Response
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

Start server

Start the server associated with the given ID.

POST
/baremetal/v1alpha1/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
Request Example
{}
200 Response
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

Stop server

Stop the server associated with the given ID.

POST
/baremetal/v1alpha1/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
id
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, undelivered, ready, stopping, stopped, starting, error, deleting and locked. The default value is unknown.
offer_id
string
Offer ID of the server.
install
object
Information about the last installation of the server.
os_id
string
ID of the OS.
hostname
string
Host defined in the server install.
ssh_key_ids
array
SSH public key IDs defined in the server install.
status
string
Status of the server install. Possible values are unknown, completed, installing, to_install and error. The default value is unknown.
tags
array
Array of customs tags attached to the server.
ips
array
Array of IPs attached to the server.
id
string
ID of the IP.
address
string
Address of the IP.
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
nullable 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 normal and rescue. The default value is normal.
zone
string
The zone in which is the server.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "name": "string",
  "description": "string",
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "offer_id": "string",
  "install": {
    "os_id": "string",
    "hostname": "string",
    "ssh_key_ids": [
      "string"
    ],
    "status": "unknown"
  },
  "tags": [
    "string"
  ],
  "ips": [
    {
      "id": "string",
      "address": "string",
      "reverse": "string",
      "version": "Ipv4",
      "reverse_status": "unknown",
      "reverse_status_message": "string"
    }
  ],
  "domain": "string",
  "boot_type": "normal",
  "zone": "string"
}

Remote access

Remote access allow you to access serie console of your baremetal server. The remote access feature is available one hour after the installation of the server.

Get remote server access

Get the remote server access associated with the given ID.

GET
/baremetal/v1alpha1/zones/{zone}/servers/{server_id}/remote-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.
login
string
The login to use for the remote access authentification.
password
string
The password to use for the remote access authentification.
expires_at
string
The date after which the remote access will be closed.
Response Example
{
  "url": "string",
  "login": "string",
  "password": "string",
  "expires_at": "string"
}

Create remote server access

Create remote server access associated with the given ID. The remote access is available one hour after the installation of the server.

POST
/baremetal/v1alpha1/zones/{zone}/servers/{server_id}/remote-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
ip
required string
The IP authorized to connect to the given server.
Request Example
{
  "ip": "string"
}
200 Response
url
string
URL to access to the server console.
login
string
The login to use for the remote access authentification.
password
string
The password to use for the remote access authentification.
expires_at
string
The date after which the remote access will be closed.
Response Example
{
  "url": "string",
  "login": "string",
  "password": "string",
  "expires_at": "string"
}

Delete remote server access

Delete remote server access associated with the given ID.

DELETE
/baremetal/v1alpha1/zones/{zone}/servers/{server_id}/remote-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

List offers

List all available server offers.

GET
/baremetal/v1alpha1/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.
id
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 with the offer.
commercial_range
string
Commercial range of the offer.
price_by_minute
object
Price of the offer by minutes, this field is deprecated, please use `price_per_sixty_minutes` instead.
currency_code
string
units
number
nanos
number
price_by_month
object
Price of the offer by months, this field is deprecated, please use `price_per_month` instead.
currency_code
string
units
number
nanos
number
price_per_sixty_minutes
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
disk
array
Disks specifications of the offer.
capacity
number
Capacity of the disk in GB.
type
string
Type of the disk.
enable
boolean
True if the offer is currently available.
cpu
array
CPU specifications of the offer.
name
string
Name of the CPU.
cores
number
Number of cores of the CPU.
threads
number
Number of threads of the CPU.
frequency
number
memory
array
Memory specifications of the offer.
capacity
number
type
string
frequency
number
ecc
boolean
quota_name
string
Name of the quota associated to the offer.
Response Example
{
  "total_count": 42,
  "offers": [
    {
      "id": "string",
      "name": "string",
      "stock": "empty",
      "bandwidth": 42,
      "commercial_range": "string",
      "price_by_minute": {
        "currency_code": "string",
        "units": 42,
        "nanos": 42
      },
      "price_by_month": {
        "currency_code": "string",
        "units": 42,
        "nanos": 42
      },
      "price_per_sixty_minutes": {
        "currency_code": "string",
        "units": 42,
        "nanos": 42
      },
      "price_per_month": {
        "currency_code": "string",
        "units": 42,
        "nanos": 42
      },
      "disk": [
        {
          "capacity": 42,
          "type": "string"
        }
      ],
      "enable": "boolean",
      "cpu": [
        {
          "name": "string",
          "cores": 42,
          "threads": 42,
          "frequency": 42
        }
      ],
      "memory": [
        {
          "capacity": 42,
          "type": "string",
          "frequency": 42,
          "ecc": "boolean"
        }
      ],
      "quota_name": "string"
    }
  ]
}

Get offer

Return specific offer for the given ID.

GET
/baremetal/v1alpha1/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
id
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 with the offer.
commercial_range
string
Commercial range of the offer.
price_by_minute
object
Price of the offer by minutes, this field is deprecated, please use `price_per_sixty_minutes` instead.
currency_code
string
units
number
nanos
number
price_by_month
object
Price of the offer by months, this field is deprecated, please use `price_per_month` instead.
currency_code
string
units
number
nanos
number
price_per_sixty_minutes
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
disk
array
Disks specifications of the offer.
capacity
number
Capacity of the disk in GB.
type
string
Type of the disk.
enable
boolean
True if the offer is currently available.
cpu
array
CPU specifications of the offer.
name
string
Name of the CPU.
cores
number
Number of cores of the CPU.
threads
number
Number of threads of the CPU.
frequency
number
memory
array
Memory specifications of the offer.
capacity
number
type
string
frequency
number
ecc
boolean
quota_name
string
Name of the quota associated to the offer.
Response Example
{
  "id": "string",
  "name": "string",
  "stock": "empty",
  "bandwidth": 42,
  "commercial_range": "string",
  "price_by_minute": {
    "currency_code": "string",
    "units": 42,
    "nanos": 42
  },
  "price_by_month": {
    "currency_code": "string",
    "units": 42,
    "nanos": 42
  },
  "price_per_sixty_minutes": {
    "currency_code": "string",
    "units": 42,
    "nanos": 42
  },
  "price_per_month": {
    "currency_code": "string",
    "units": 42,
    "nanos": 42
  },
  "disk": [
    {
      "capacity": 42,
      "type": "string"
    }
  ],
  "enable": "boolean",
  "cpu": [
    {
      "name": "string",
      "cores": 42,
      "threads": 42,
      "frequency": 42
    }
  ],
  "memory": [
    {
      "capacity": 42,
      "type": "string",
      "frequency": 42,
      "ecc": "boolean"
    }
  ],
  "quota_name": "string"
}

List OS

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

GET
/baremetal/v1alpha1/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.
200 Response
total_count
number
Total count of matching OS.
os
array
OS that match filters.
id
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 OS

Return specific OS for the given ID.

GET
/baremetal/v1alpha1/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 researched OS.
200 Response
id
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"
}

Get consumptions

List all consumptions for servers.

GET
/baremetal/v1alpha1/zones/{zone}/consumptions
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
200 Response
consumptions_organizations
map
Consumptions of all your servers by quota name and organization ID (map[ORGGANIZATION_ID]map[QUOTA_NAME]CONSUMPTION).
<consumptions_organizationKey>
object
consumptions
map
Consumptions by quota name (map[QUOTA_NAME]CONSUMPTION).
<consumptionKey>
number
Response Example
{
  "consumptions_organizations": {
    "<consumptions_organizationKey>": {
      "consumptions": {
        "<consumptionKey>": 42
      }
    }
  }
}

IP Failovers

The IPs failovers could be attach to any server in the same zone. A server could be linked with multiple failovers.

The mac of failover can be generated for specifics needs:

  • KVM
  • Xen
  • VMware
  • Duplicated from another failover attached on the same server

List IP failovers

List all created IP failovers.

GET
/baremetal/v1alpha1/zones/{zone}/ip-failovers
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 IP failover per page. The default value is 20.
order_by
string
Order of the IP failovers. Possible values are created_at_asc and created_at_desc. The default value is created_at_asc.
tags
array
Filter IP failovers by tags.
status
array
Filter IP failovers by status.
server_ids
array
Filter IP failovers by server IDs.
organization_id
nullable string
Filter servers by organization ID.
200 Response
total_count
number
Total count of matching IP failovers.
failovers
array
Listing of failovers.
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "total_count": 42,
  "failovers": [
    {
      "id": "string",
      "organization_id": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "updated_at": "string",
      "created_at": "string",
      "status": "unknown",
      "ip_address": "string",
      "mac_address": "string",
      "server_id": "string",
      "mac_type": "unknown_mac_type",
      "reverse": "string",
      "reverse_status": "unknown",
      "reverse_status_message": "string",
      "zone": "string"
    }
  ]
}

Create IP failover

Create an IP failover. Once the IP failover is created, you probably want to attach it to a server.

POST
/baremetal/v1alpha1/zones/{zone}/ip-failovers
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
Body
organization_id
required string
ID of the organization to associate to the IP failover.
description
string
Description to associate to the IP failover, max 255 characters.
tags
array
Tags to associate to the IP failover.
mac_type
string
MAC type to use for the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
duplicate_mac_from
nullable string
ID of the IP failover which must be duplicate.
Request Example
{
  "organization_id": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "mac_type": "unknown_mac_type",
  "duplicate_mac_from": "string"
}
200 Response
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "ip_address": "string",
  "mac_address": "string",
  "server_id": "string",
  "mac_type": "unknown_mac_type",
  "reverse": "string",
  "reverse_status": "unknown",
  "reverse_status_message": "string",
  "zone": "string"
}

Get IP failover

Get the IP failover associated with the given ID.

GET
/baremetal/v1alpha1/zones/{zone}/ip-failovers/{ip_failover_id}
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
ip_failover_id
required string
ID of the IP failover.
200 Response
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "ip_address": "string",
  "mac_address": "string",
  "server_id": "string",
  "mac_type": "unknown_mac_type",
  "reverse": "string",
  "reverse_status": "unknown",
  "reverse_status_message": "string",
  "zone": "string"
}

Update IP failover

Update the IP failover associated with the given IP.

PATCH
/baremetal/v1alpha1/zones/{zone}/ip-failovers/{ip_failover_id}
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
ip_failover_id
required string
ID of the IP failover to update.
Body
description
nullable string
Description to associate to the IP failover, max 255 characters, not updated if null.
tags
nullable array
Tags to associate to the IP failover, not updated if null.
mac_type
string
MAC type to use for the IP failover, not updated if null. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
duplicate_mac_from
nullable string
ID of the IP failover which must be duplicate, not updated if null.
reverse
nullable string
New reverse IP to update, not updated if null.
Request Example
{
  "description": "string",
  "tags": [
    "string"
  ],
  "mac_type": "unknown_mac_type",
  "duplicate_mac_from": "string",
  "reverse": "string"
}
200 Response
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "ip_address": "string",
  "mac_address": "string",
  "server_id": "string",
  "mac_type": "unknown_mac_type",
  "reverse": "string",
  "reverse_status": "unknown",
  "reverse_status_message": "string",
  "zone": "string"
}

Delete IP failover

Delete the IP failover associated with the given IP.

DELETE
/baremetal/v1alpha1/zones/{zone}/ip-failovers/{ip_failover_id}
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
ip_failover_id
required string
ID of the IP failover to delete.
200 Response
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "id": "string",
  "organization_id": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "updated_at": "string",
  "created_at": "string",
  "status": "unknown",
  "ip_address": "string",
  "mac_address": "string",
  "server_id": "string",
  "mac_type": "unknown_mac_type",
  "reverse": "string",
  "reverse_status": "unknown",
  "reverse_status_message": "string",
  "zone": "string"
}

List IP failover events

List IP failover events associated with the given ID.

GET
/baremetal/v1alpha1/zones/{zone}/ip-failovers/{ip_failover_id}/events
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
ip_failover_id
required string
ID of the IP failover events searched.
Query Parameters
page
number
Page number. The default value is 1.
page_size
number
Number of IP failover events per page. The default value is 20.
order_by
string
Order of the IP failover 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 IP failover events.
event
array
IP failover events that match filters.
id
string
ID of the IP failover for whom the action will be applied.
action
string
The action that will be applied to the IP failover. Possible values are unknown, billing_start, billing_stop, order_fail, update_ip and update_ip_fail. The default value is unknown.
updated_at
string
Date of last modification of the action.
created_at
string
Date of creation of the action.
Response Example
{
  "total_count": 42,
  "event": [
    {
      "id": "string",
      "action": "unknown",
      "updated_at": "string",
      "created_at": "string"
    }
  ]
}

Attach IP failovers

Attach IP failovers to the given server ID.

POST
/baremetal/v1alpha1/zones/{zone}/ip-failovers/attach
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
Body
ip_failover_ids
array
IP failover IDs to attach to the server.
server_id
string
ID of the server to attach to the IP failovers.
Request Example
{
  "ip_failover_ids": [
    "string"
  ],
  "server_id": "string"
}
200 Response
failovers
array
List of the attached IP failovers.
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "failovers": [
    {
      "id": "string",
      "organization_id": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "updated_at": "string",
      "created_at": "string",
      "status": "unknown",
      "ip_address": "string",
      "mac_address": "string",
      "server_id": "string",
      "mac_type": "unknown_mac_type",
      "reverse": "string",
      "reverse_status": "unknown",
      "reverse_status_message": "string",
      "zone": "string"
    }
  ]
}

Detach IP failovers

Detach IP failovers to the given server ID.

POST
/baremetal/v1alpha1/zones/{zone}/ip-failovers/detach
Path Parameters
zone
required string
The zone you want to target. Possible value is fr-par-2.
Body
ip_failover_ids
array
IP failover IDs to detach to the server.
Request Example
{
  "ip_failover_ids": [
    "string"
  ]
}
200 Response
failovers
array
List of the detached IP failovers.
id
string
ID of the IP failover.
organization_id
string
Organization ID the IP failover is attached to.
description
string
Description of the IP failover.
tags
array
Tags associated to the IP failover.
updated_at
string
Date of last update of the IP failover.
created_at
string
Date of creation of the IP failover.
status
string
Status of the IP failover. Possible values are unknown, delivering, ready, updating, error, deleting and locked. The default value is unknown.
ip_address
string
IP of the IP failover.
mac_address
string
Mac address of the IP failover.
server_id
string
ServerID linked to the IP failover.
mac_type
string
Type of the MAC generated of the IP failover. Possible values are unknown_mac_type, none, duplicate, vmware, xen and kvm. The default value is unknown_mac_type.
reverse
string
Reverse IP value.
reverse_status
string
Status of the reverse. Possible values are unknown, pending, active and error. The default value is unknown.
reverse_status_message
nullable string
A message related to the reverse status, in case of an error for example.
zone
string
The zone in which is the ip.
Response Example
{
  "failovers": [
    {
      "id": "string",
      "organization_id": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "updated_at": "string",
      "created_at": "string",
      "status": "unknown",
      "ip_address": "string",
      "mac_address": "string",
      "server_id": "string",
      "mac_type": "unknown_mac_type",
      "reverse": "string",
      "reverse_status": "unknown",
      "reverse_status_message": "string",
      "zone": "string"
    }
  ]
}