Skip to content
Console(the OVHcloud Console, opens in a new tab)

Deployments

All operations require authentication, except the 4 marked Public.

20 operationsv1/dedicated/installationTemplate · /dedicated/server
OpenAPI
Agent setup

Install an operating systemProduction

POST
/1.0/dedicated/server/{serviceName}/reinstall

Installs an operating system on the server and returns the installation task. operatingSystem must be one of the names returned by GET /dedicated/server/{serviceName}/install/compatibleTemplates. By default, all disks of the disk group are erased.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

customizations
Customizations

OS reinstallation customizations

operatingSystem
required
string

Operating System name to install (available values for this server can be retrieved using GET /dedicated/server/{serviceName}/install/compatibleTemplates)

properties
object

(⚠ Deprecated parameter ⚠, use configDriveMetadata customization instead) Arbitrary properties to pass to cloud-init's config drive datasource

storage
Storage[]
—

Response

200Responsesuccessful operation
comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Task Completion date

function
read-only
FunctionEnum

Task operation type

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
startDate
read-only
stringdate-time

Task Creation date

status
read-only
StatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
taskId
read-only
integer

Task id

400objectError 400 response
403objectError 403 response
404objectError 404 response
409objectError 409 response
500objectError 500 response
501objectError 501 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/reinstall \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "comment": "string",  "doneDate": "2024-01-01T12:00:00Z",  "function": "INFRA_002_VirtualNetworkInterface",  "startDate": "2024-01-01T12:00:00Z",  "status": "cancelled",  "taskId": 0}

List compatible partitioning schemesProduction

GET
/1.0/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes

List compatible partitioning schemes. Returns the names of the partitioning schemes of the installation template given in templateName that are compatible with the server.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Query parameters

templateName
required
string
—

Response

200string[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

List compatible installation templatesProduction

GET
/1.0/dedicated/server/{serviceName}/install/compatibleTemplates

List compatible installation templates. Returns the names of the installation templates compatible with the server, in the ovh list. Use one of them as operatingSystem to reinstall the server.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200InstallTemplatesuccessful operation
ovh
string[]

Names list of ovh installationtemplates compatibles with this server

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/compatibleTemplates \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "ovh": [    "string"  ]}

Get the hardware RAID profileProduction

GET
/1.0/dedicated/server/{serviceName}/install/hardwareRaidProfile

Get the hardware RAID profile. Returns the hardware RAID controllers of the server, with their type, model and connected disks.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200HardwareRaidProfilesuccessful operation
controllers
HardwareRaidController[]

Hardware RAID controller list

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/hardwareRaidProfile \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "controllers": [    {      "disks": [        {          "capacity": {            "unit": "string",            "value": 0          },          "diskGroupId": 0,          "names": [            "string"          ],          "speed": {            "unit": "string",            "value": "string"          },          "type": "NVMe"        }      ],      "model": "string",      "type": "string"    }  ]}

Get the installation statusProduction

GET
/1.0/dedicated/server/{serviceName}/install/status

Get the installation status. Returns the progress of the operating system installation on the server: the elapsed time in seconds and the status of each step. When no installation is in progress, the call returns an error.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200InstallationProgressStatussuccessful operation
elapsedTime
integer

Elapsed time in seconds since installation beggining

progress
InstallationProgressSteps[]

Installation steps

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/status \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "elapsedTime": 0,  "progress": [    {      "comment": "string",      "error": "string",      "status": "doing"    }  ]}

List compatible netbootsProduction

GET
/1.0/dedicated/server/{serviceName}/boot

List compatible netboots. Returns the identifiers of the netboots compatible with the server. Filter them by boot type (harddisk, network, rescue, internal or power) with the bootType parameter.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Query parameters

bootType
BootTypeEnum

Filter the value of bootType property (=)

Valuesharddiskinternalnetworkpowerrescue

Response

200integer[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  0]

Get a netbootProduction

GET
/1.0/dedicated/server/{serviceName}/boot/{bootId}

Get a netboot. Returns a netboot compatible with the server: its boot type, its kernel and its description.

Path parameters

bootId
required
integer

boot id

serviceName
required
string

The internal name of your dedicated server

Response

200Netbootsuccessful operation
bootId
read-only
integer

boot id

bootType
read-only
BootTypeEnum

the boot system

Valuesharddiskinternalnetworkpowerrescue
description
read-only
string

the boot description

kernel
read-only
string

The boot kernel

Example uses bootId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot/{bootId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "bootId": 0,  "bootType": "harddisk",  "description": "string",  "kernel": "string"}

List netboot optionsProduction

GET
/1.0/dedicated/server/{serviceName}/boot/{bootId}/option

List netboot options. Returns the options activated on the netboot, among cpufamily, grsec, ipv6 and smp.

Path parameters

bootId
required
integer

boot id

serviceName
required
string

The internal name of your dedicated server

Response

200BootOptionEnum[]successful operation

Example uses bootId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot/{bootId}/option \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "cpufamily"]

Get a netboot optionProduction

GET
/1.0/dedicated/server/{serviceName}/boot/{bootId}/option/{option}

Get a netboot option. Returns the value of an option activated on the netboot. The option is one of cpufamily, grsec, ipv6 or smp.

Path parameters

bootId
required
integer

boot id

option
required
BootOptionEnum

The option of this boot

Valuescpufamilygrsecipv6smp
serviceName
required
string

The internal name of your dedicated server

Response

200netbootOptionsuccessful operation
option
read-only
BootOptionEnum

The option of this boot

Valuescpufamilygrsecipv6smp
value
read-only
string

the value of this option

Example uses bootId = 0, option = cpufamily, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot/{bootId}/option/{option} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "option": "cpufamily",  "value": "string"}

Reboot the serverProduction

POST
/1.0/dedicated/server/{serviceName}/reboot

Reboot the server. Performs a hard reboot of the server: the power is cycled without a clean shutdown of the operating system. Returns the reboot task, with its status and completion date.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/reboot \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "changeUuid": "string",  "comment": "string",  "doneDate": "2024-01-01T12:00:00Z",  "function": "INFRA_002_VirtualNetworkInterface",  "lastUpdate": "2024-01-01T12:00:00Z",  "needSchedule": true,  "note": "string",  "plannedInterventionId": 0,  "startDate": "2024-01-01T12:00:00Z",  "status": "cancelled",  "tags": [    {      "key": "string",      "value": "string"    }  ],  "taskId": 0,  "ticketReference": "string"}

List operating systems by hardwareProductionPublic

GET
/1.0/dedicated/server/osAvailabilities

Returns the names of the operating systems available for the hardware reference given in the hardware parameter. This call does not require authentication.

Query parameters

hardware
required
string

Hardware reference requested

Response

200string[]successful operation

Public: no token needed

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/osAvailabilities
ResponseExample
[  "string"]

List installation templatesProductionPublic

GET
/1.0/dedicated/installationTemplate

List installation templates. Returns the names of the operating system installation templates. This call does not require authentication. To get the templates compatible with a server, use GET /dedicated/server/{serviceName}/install/compatibleTemplates.

Response

200string[]successful operation

Public: no token needed

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate
ResponseExample
[  "string"]

List installation template detailsProductionPublic

GET
/1.0/dedicated/installationTemplate/templateInfos

List installation template details. Returns the details of the available operating system templates: name, category, family, subfamily, end of install date, project and license. This call does not require authentication.

Response

200TemplateOsInfo[]successful operation
category
TemplateOsUsageEnum

OS Category (also called OS usage)

ValuesbackupbasiccustomerdatabaseerphostingmanagementotherreadyToUsevirtualisationvirtualization
description
string

OS long name

endOfInstall
stringdate

OS template end of install at OVH date

family
TemplateOsTypeEnum

OS family (also called OS type)

Valuesbsdcustomibmlinuxsolarisunixwindows
license
TemplateOsInfoLicense

OS template license details

project
TemplateOsInfoProject

OS template project details

subfamily
TemplateOsSubfamilyEnum

OS subfamily

Valuesalmaaosarchbyoibyolinuxcentoscloudlinuxcoreosdebiandgxesxifedorafreebsdgentoohypervomniosopenioopenmediavaultopensuseovhpcspowerproxmoxrhelrockyslackwaresles-sapsmartossolusvmubuntuwindows-server-corewindows-server-desktop-expxcpxen
templateName
string

OS template name

Public: no token needed

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/templateInfos
ResponseExample
[  {    "category": "backup",    "description": "string",    "endOfInstall": "2024-01-01",    "family": "bsd",    "license": {      "os": {        "name": [          "0BSD"        ],        "url": "string"      },      "usage": {        "name": [          "0BSD"        ],        "url": "string"      }    },    "project": {      "os": {        "governance": [          "string"        ],        "name": "string",        "releaseNotes": "string",        "url": "string",        "version": "string"      },      "usage": {        "governance": [          "string"        ],        "name": "string",        "releaseNotes": "string",        "url": "string",        "version": "string"      }    },    "subfamily": "alma",    "templateName": "string"  }]

Get an installation templateProductionPublic

GET
/1.0/dedicated/installationTemplate/{templateName}

Get an installation template. Returns the details of an installation template, such as its distribution, family, filesystems and inputs. After its endOfInstall date, the template can no longer be installed. This call does not require authentication.

Path parameters

templateName
required
string

This template name

Response

200Templatessuccessful operation
bitFormat
read-only
BitFormatEnum

this template bit format

Values3264
category
read-only
TemplateOsUsageEnum

category of this template (informative only)

ValuesbackupbasiccustomerdatabaseerphostingmanagementotherreadyToUsevirtualisationvirtualization
description
read-only
string

information about this template

distribution
read-only
string

the distribution this template is based on

endOfInstall
read-only
stringdate

after this date, install of this template will not be possible at OVH

family
read-only
TemplateOsTypeEnum

this template family type

Valuesbsdcustomibmlinuxsolarisunixwindows
filesystems
read-only
FileSystemEnum[]

list of all filesystems available for this template

Valuesbtrfsext3ext4fat16nonentfsreiserfsswapufsvmfs5vmfs6vmfslxfszfs
inputs
read-only
TemplateOsInput[]

Inputs

license
read-only
TemplateOsInfoLicense

This distribution licensing details

lvmReady
read-only
boolean

This distribution supports Logical Volumes (Linux LVM)

noPartitioning
read-only
boolean

Partitioning customization is not available for this OS template

project
read-only
TemplateOsInfoProject

This distribution project details

rootMountpoint
read-only
string

The mandatory mount point of the root filesystem on this OS

softRaidOnlyMirroring
read-only
boolean

Partitioning customization is available but limited to mirroring for this OS template

subfamily
read-only
TemplateOsSubfamilyEnum

this template subfamily type

Valuesalmaaosarchbyoibyolinuxcentoscloudlinuxcoreosdebiandgxesxifedorafreebsdgentoohypervomniosopenioopenmediavaultopensuseovhpcspowerproxmoxrhelrockyslackwaresles-sapsmartossolusvmubuntuwindows-server-corewindows-server-desktop-expxcpxen
templateName
read-only
string

This template name

Example uses templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}
ResponseExample
{  "bitFormat": 32,  "category": "backup",  "description": "string",  "distribution": "string",  "endOfInstall": "2024-01-01",  "family": "bsd",  "filesystems": [    "btrfs"  ],  "inputs": [    {      "default": "string",      "description": "string",      "enum": [        "string"      ],      "mandatory": true,      "name": "string",      "type": "boolean"    }  ],  "license": {    "os": {      "name": [        "0BSD"      ],      "url": "string"    },    "usage": {      "name": [        "0BSD"      ],      "url": "string"    }  },  "lvmReady": true,  "noPartitioning": true,  "project": {    "os": {      "governance": [        "string"      ],      "name": "string",      "releaseNotes": "string",      "url": "string",      "version": "string"    },    "usage": {      "governance": [        "string"      ],      "name": "string",      "releaseNotes": "string",      "url": "string",      "version": "string"    }  },  "rootMountpoint": "string",  "softRaidOnlyMirroring": true,  "subfamily": "alma",  "templateName": "string"}

List partitioning schemesProduction

GET
/1.0/dedicated/installationTemplate/{templateName}/partitionScheme

List partitioning schemes. Returns the names of the partitioning schemes of the template. On a reinstall without a partitioning scheme, the compatible scheme with the highest priority is used.

Path parameters

templateName
required
string

This template name

Response

200string[]successful operation

Example uses templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

Get a partitioning schemeProduction

GET
/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}

Get a partitioning scheme. Returns the name and priority of a partitioning scheme. On a reinstall without a partitioning scheme, the compatible scheme with the highest priority is used.

Path parameters

schemeName
required
string

This partitioning scheme name

templateName
required
string

This template name

Response

200templatePartitioningSchemessuccessful operation
name
read-only
string

This partitioning scheme name

priority
read-only
integer

on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications)

Example uses schemeName = string, templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "name": "string",  "priority": 0}

List hardware RAIDsProduction

GET
/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid

List hardware RAIDs. Returns the names of the hardware RAIDs defined in the partitioning scheme. Each one has a RAID mode, a disk list and a creation order.

Path parameters

schemeName
required
string

This partitioning scheme name

templateName
required
string

This template name

Response

200string[]successful operation

Example uses schemeName = string, templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

Get a hardware RAIDProduction

GET
/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}

Get a hardware RAID. Returns the RAID mode, the disks and the creation order of a hardware RAID defined in the partitioning scheme.

Path parameters

name
required
string

Hardware RAID name

schemeName
required
string

This partitioning scheme name

templateName
required
string

This template name

Response

200hardwareRaidsuccessful operation
disks
read-only
string[]

Disk list

mode
read-only
TemplateOsHardwareRaidEnum

RAID mode

Valuesraid0raid1raid10raid5raid50raid6raid60
name
read-only
string

Hardware RAID name

step
read-only
integer

Specifies the creation order of the hardware RAID

Example uses name = string, schemeName = string, templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "disks": [    "string"  ],  "mode": "raid0",  "name": "string",  "step": 0}

List partitionsProduction

GET
/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition

List partitions. Returns the mount points of the partitions defined in the partitioning scheme. Each partition has a filesystem, a type, a size and a creation order on the disk.

Path parameters

schemeName
required
string

This partitioning scheme name

templateName
required
string

This template name

Response

200string[]successful operation

Example uses schemeName = string, templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

Get a partitionProduction

GET
/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}

Get a partition. Returns the filesystem, type, size, RAID level and creation order of a partition of the partitioning scheme. A size of 0 means the rest of the disk space.

Path parameters

mountpoint
required
string

Partition mount point

schemeName
required
string

This partitioning scheme name

templateName
required
string

This template name

Response

200templatePartitionssuccessful operation
filesystem
read-only
FileSystemEnum

Partition filesytem

Valuesbtrfsext3ext4fat16nonentfsreiserfsswapufsvmfs5vmfs6vmfslxfszfs
mountpoint
read-only
string

Partition mount point

order
read-only
integer

specifies the creation order of the partition on the disk

raid
read-only
PartitionRaidEnum

Partition raid

Values0110567
size
read-only
UnitAndValue_long

Partition size (unit: MB GB TB, MB by default), 0 => rest of the space

type
read-only
TemplatePartitionTypeEnum

Partition type

Valueslogicallvprimary
volumeName
read-only
string

Logical volume name (required if type is lv) or optional zpool name if filesystem is ZFS

Example uses mountpoint = string, schemeName = string, templateName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "filesystem": "btrfs",  "mountpoint": "string",  "order": 0,  "raid": "0",  "size": {    "unit": "string",    "value": 0  },  "type": "logical",  "volumeName": "string"}