My customer accountSales contactWebmailOVHcloud Blog

Welcome to OVHcloud.

Log in to order, manage your products and services, and track your orders

Log in
OVH Guides

How to use the Bring Your Own Image feature

Find out how to easily deploy your own images on dedicated servers using the OVHcloud APIv6

Last updated 16th February 2021


The Bring Your Own Image technology (BYOI) enables you to deploy cloudready images directly on your dedicated server. You can therefore use the bare metal service as a resource for your deployments.

You can also make use of this option when reinstalling a server from the OVHcloud Control Panel (see the "Getting started" guide). Please use the instructions below as a reference.

This guide explains how to use BYOI through the OVHcloud APIv6.


A new installation with BYOI will erase all the data on the server.


Technical limitations

There are some technical limitations linked to the use of physical products such as dedicated servers. Here is a non-exhaustive list, to keep in mind during your deployment preparation:

  • Boot type : uefi or legacy
  • Partition type : MBR or GPT
  • Image format : qcow2 or raw

If your server has a uefi boot type, be sure to add an EFI partition to your image template.

Deploying your image

Log in to then go to the /dedicated/server section. You can use the Filter field to look for "BringYourOwnImage".

The BYOI feature uses 3 API calls.

calls API

To deploy your image, use the following API call and complete the required fields:

Field Description
serviceName Your server's name.
URL The URL to retrieve your image from.
checkSum Your image's checksum.
checkSumType Your image's checksum type (md5, sha1, sha256, sha512).
enable (ConfigDrive)* Create ConfigDrive partition (cloud-init)
hostname (ConfigDrive)* Your server's hostname.
sshKey (ConfigDrive)* Your public SSH key.
userData (ConfigDrive)* Your post-install script.
userMetadatas (ConfigDrive)* Meta data used by CloudInit when booting.
description Your image's name.
diskGroupId The disk ID on which you want to install your image.
httpHeader Only if necessary to download your image.
type Your image's type/format (qcow2, raw, ova).

* ConfigDrive partition is used by cloud-init while first server boot in order to configure it with your needs. You can choose to enable it or not.


After you have completed the fields, start the deployment by clicking Execute.

Checking a deployment

You can track the deployment of your image through the API call below or through the KVM / IPMI.

In this example, the deployment is starting.

GET API call

Deployment can take up to 10 minutes. When the operation is complete, your deployment status will change to "done" and your server will be restarted to disk.

Result examples

Here are some results examples you might have :

Message Meaning
Can't write qcow2 on disk. Could not burn qcow2 image on disk.
Could not download, qcow2 image is too big to download in memory. There is not enough RAM space to store your image.
Could not download image located : http://path/of/your/image. Impossible to download image located http://path/of/your/image.
Bad format image, expected : qcow2, raw. Incorrect image format.
Bad checkSumType, expected : sha1, sha256, md5. Incorrect checksum type.
Bad $checkSumType for downloaded file, got : 1234 while expecting 5678. Incorrect checksum signature.
Can not move backup GPT data structures to the end of disk. Disk format is not correct.
Could not create configdrive on disk. Impossible to create config-drive partition.

Deleting a deployment

You can choose to remove your deployment by using the following API call:

This will erase the deployment status and put your server in rescue mode.

Go further

Join our user community on

Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.

These guides might also interest you...