# Bare Metal Cloud › Dedicated Servers › Deployments API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Bare Metal Cloud product's sections: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 20 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/bare-metal-cloud/dedicated-servers/deployments.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/bare-metal-cloud/dedicated-servers/deployments.json?format=openapi3

## Operations

- `POST /dedicated/server/{serviceName}/reinstall` — Install an operating system
- `GET /dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes` — List compatible partitioning schemes
- `GET /dedicated/server/{serviceName}/install/compatibleTemplates` — List compatible installation templates
- `GET /dedicated/server/{serviceName}/install/hardwareRaidProfile` — Get the hardware RAID profile
- `GET /dedicated/server/{serviceName}/install/status` — Get the installation status
- `GET /dedicated/server/{serviceName}/boot` — List compatible netboots
- `GET /dedicated/server/{serviceName}/boot/{bootId}` — Get a netboot
- `GET /dedicated/server/{serviceName}/boot/{bootId}/option` — List netboot options
- `GET /dedicated/server/{serviceName}/boot/{bootId}/option/{option}` — Get a netboot option
- `POST /dedicated/server/{serviceName}/reboot` — Reboot the server
- `GET /dedicated/server/osAvailabilities` — List operating systems by hardware
- `GET /dedicated/installationTemplate` — List installation templates
- `GET /dedicated/installationTemplate/templateInfos` — List installation template details
- `GET /dedicated/installationTemplate/{templateName}` — Get an installation template
- `GET /dedicated/installationTemplate/{templateName}/partitionScheme` — List partitioning schemes
- `GET /dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}` — Get a partitioning scheme
- `GET /dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid` — List hardware RAIDs
- `GET /dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}` — Get a hardware RAID
- `GET /dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition` — List partitions
- `GET /dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}` — Get a partition

## Install an operating system

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#post-dedicated-server-servicename-reinstall

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh: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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Request body (required)

Type: `dedicated.server.Reinstall`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `customizations` | dedicated.server.reinstall.Customizations |  | OS reinstallation customizations |
| `customizations.appToInstall` | dedicated.server.reinstall.customizations.AppToInstallEnum |  | Application to install with the auto installer — one of `coolify`, `discourse`, `dokploy`, `drupal`, `easypanel`, `fastpanel`, `game-panel`, `hestiacp`, `matomo`, `n8n`, `nextcloud`, `openclaw`, … |
| `customizations.configDriveMetadata` | object |  | Config Drive MetaData |
| `customizations.configDriveUserData` | string |  | Config Drive UserData |
| `customizations.efiBootloaderPath` | string |  | Path of the EFI bootloader from the OS installed on the server |
| `customizations.enableLacpBonding` | boolean |  | Enable LACP to aggregate multiple network interfaces (if applicable) |
| `customizations.hostname` | string |  | Custom hostname |
| `customizations.httpHeaders` | object |  | Image HTTP Headers |
| `customizations.imageCheckSum` | string |  | Image checksum |
| `customizations.imageCheckSumType` | dedicated.server.reinstall.customizations.ImageCheckSumTypeEnum |  | Checksum type — one of `md5`, `sha1`, `sha256`, `sha512` |
| `customizations.imageType` | dedicated.server.reinstall.customizations.ImageTypeEnum |  | Image Type — one of `qcow2`, `raw` |
| `customizations.imageURL` | string |  | Image URL |
| `customizations.language` | dedicated.server.reinstall.customizations.LanguageEnum |  | Display Language — one of `cs-cz`, `de-de`, `en-us`, `es-es`, `fr-fr`, `it-it`, `nl-nl`, `pl-pl`, `pt-pt` |
| `customizations.nutanixConfiguration` | object |  | Nutanix specific configuration |
| `customizations.postInstallationScript` | string |  | Post-Installation Script |
| `customizations.postInstallationScriptExtension` | dedicated.server.reinstall.customizations.PostInstallationScriptExtensionEnum |  | Post-Installation Script File Extension — one of `cmd`, `ps1` |
| `customizations.sshKey` | string |  | SSH Public Key |
| `customizations.version` | string |  | Flavor version |
| `operatingSystem` | string | yes | 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` | dedicated.server.reinstall.Storage[] |  |  |
| `storage[].diskGroupId` | integer |  | Disk group id (default is 0, meaning automatic) |
| `storage[].erase` | boolean |  | Erase all disks of this diskGroup (default is true) |
| `storage[].hardwareRaid` | dedicated.server.reinstall.storage.HardwareRaid[] |  |  |
| `storage[].hardwareRaid[].arrays` | integer |  | Number of arrays (default is 1) |
| `storage[].hardwareRaid[].disks` | integer |  | Total number of disks in the disk group involved in the hardware raid configuration (all disks of the disk group by default) |
| `storage[].hardwareRaid[].raidLevel` | dedicated.server.reinstall.storage.hardwareRaid.RaidLevelEnum |  | Hardware raid type (default is 1; if set to null, all disks of the chosen disk group will be configured in JBOD mode) — one of `0`, `1`, `5`, `6`, `10`, `50`, `60` |
| `storage[].hardwareRaid[].spares` | integer |  | Number of disks in the disk group involved in the spare (default is 0) |
| `storage[].partitioning` | dedicated.server.reinstall.storage.Partitioning |  | Partitioning configuration |
| `storage[].partitioning.disks` | integer |  | Total number of disks in the disk group involved in the partitioning configuration (all disks of the disk group by default) |
| `storage[].partitioning.layout` | dedicated.server.reinstall.storage.partitioning.Layout[] |  |  |
| `storage[].partitioning.schemeName` | string |  | Partitioning scheme (if applicable with selected operating system) |

```json
{
  "customizations": {
    "appToInstall": "coolify",
    "configDriveMetadata": {
      "key": "string"
    },
    "configDriveUserData": "string",
    "efiBootloaderPath": "string",
    "enableLacpBonding": true,
    "hostname": "string",
    "httpHeaders": {
      "key": "string"
    },
    "imageCheckSum": "string",
    "imageCheckSumType": "md5",
    "imageType": "qcow2",
    "imageURL": "string",
    "language": "cs-cz",
    "nutanixConfiguration": {
      "key": "string"
    },
    "postInstallationScript": "string",
    "postInstallationScriptExtension": "cmd",
    "sshKey": "string",
    "version": "string"
  },
  "operatingSystem": "string",
  "properties": {
    "key": "string"
  },
  "storage": [
    {
      "diskGroupId": 0,
      "erase": true,
      "hardwareRaid": [
        {
          "arrays": 0,
          "disks": 0,
          "raidLevel": 0,
          "spares": 0
        }
      ],
      "partitioning": {
        "disks": 0,
        "layout": [
          {
            "extras": {
              "lv": null,
              "zp": null
            },
            "fileSystem": "btrfs",
            "mountPoint": "string",
            "raidLevel": 0,
            "size": 0
          }
        ],
        "schemeName": "string"
      }
    }
  ]
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.task.Response | successful operation |
| 400 | object | Error 400 response |
| 403 | object | Error 403 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |
| 500 | object | Error 500 response |
| 501 | object | Error 501 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | string | read-only | Details of this task |
| `doneDate` | string (date-time) | read-only | Task Completion date |
| `function` | dedicated.server.task.FunctionEnum | read-only | Task operation type — one of `INFRA_002_VirtualNetworkInterface`, `INFRA_002_VirtualNetworkInterface_group`, `INFRA_002_VirtualNetworkInterface_ungroup`, `INFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_group`, `INFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroup`, `INFRA_ONE_NETWORK_VirtualNetworkInterface_group`, `INFRA_ONE_NETWORK_VirtualNetworkInterface_ungroup`, `addVirtualMac`, `addWindowSplaFromExistingSerial`, `applyBackupFtpAcls`, `applyBackupFtpQuota`, `bypassAntiDDosGame`, … |
| `startDate` | string (date-time) | read-only | Task Creation date |
| `status` | dedicated.server.task.StatusEnum | read-only | Task status — one of `cancelled`, `customerError`, `doing`, `done`, `init`, `ovhError`, `todo` |
| `taskId` | integer | read-only | Task id |

```json
{
  "comment": "string",
  "doneDate": "2024-01-01T12:00:00Z",
  "function": "INFRA_002_VirtualNetworkInterface",
  "startDate": "2024-01-01T12:00:00Z",
  "status": "cancelled",
  "taskId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/reinstall" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: dedicated.server.Reinstall
result = client.post("/dedicated/server/{serviceName}/reinstall",
	customizations = None, #  (type: )
	operatingSystem = None, # Operating System name to install (available values for this server can be retrieved using GET /dedicated/server/{serviceName}/install/compatibleTemplates) (type: string)
	properties = None, # (⚠ Deprecated parameter ⚠, use configDriveMetadata customization instead) Arbitrary properties to pass to cloud-init's config drive datasource (type: object)
	storage = None, #  (type: array)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: dedicated.server.Reinstall
$result = $ovh->post("/dedicated/server/{serviceName}/reinstall", array(
	customizations => null, //  (type: )
	operatingSystem => null, // Operating System name to install (available values for this server can be retrieved using GET /dedicated/server/{serviceName}/install/compatibleTemplates) (type: string)
	properties => null, // (⚠ Deprecated parameter ⚠, use configDriveMetadata customization instead) Arbitrary properties to pass to cloud-init's config drive datasource (type: object)
	storage => null, //  (type: array)
));

print_r($result);
?>
```

## List compatible partitioning schemes

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-install-compatibletemplatepartitionschemes

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:install/compatibleTemplatePartitionSchemes/get`

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |
| `templateName` | query | string | yes |  |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes");

print_r($result);
?>
```

## List compatible installation templates

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-install-compatibletemplates

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:install/compatibleTemplates/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.InstallTemplate | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ovh` | string[] |  | Names list of ovh installationtemplates compatibles with this server |

```json
{
  "ovh": [
    "string"
  ]
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/compatibleTemplates" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/install/compatibleTemplates")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/install/compatibleTemplates");

print_r($result);
?>
```

## Get the hardware RAID profile

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-install-hardwareraidprofile

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:install/hardwareRaidProfile/get`

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.HardwareRaidProfile | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `controllers` | dedicated.server.HardwareRaidController[] |  | Hardware RAID controller list |
| `controllers[].disks` | dedicated.server.HardwareRaidDiskGroup[] |  | Connected disk type |
| `controllers[].disks[].capacity` | complexType.UnitAndValue_long |  | Disk capacity |
| `controllers[].disks[].diskGroupId` | integer |  | Disk Group Id |
| `controllers[].disks[].names` | string[] |  | Disk names |
| `controllers[].disks[].speed` | complexType.UnitAndValue_string |  | Disk insterface speed |
| `controllers[].disks[].type` | dedicated.server.DiskTypeEnum |  | Disk type — one of `NVMe`, `SAS`, `SATA`, `SSD`, `Unknown` |
| `controllers[].model` | string |  | Raid controler model |
| `controllers[].type` | string |  | Raid controler type |

```json
{
  "controllers": [
    {
      "disks": [
        {
          "capacity": {
            "unit": "string",
            "value": 0
          },
          "diskGroupId": 0,
          "names": [
            "string"
          ],
          "speed": {
            "unit": "string",
            "value": "string"
          },
          "type": "NVMe"
        }
      ],
      "model": "string",
      "type": "string"
    }
  ]
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/hardwareRaidProfile" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/install/hardwareRaidProfile")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/install/hardwareRaidProfile");

print_r($result);
?>
```

## Get the installation status

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-install-status

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:install/status/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.InstallationProgressStatus | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `elapsedTime` | integer |  | Elapsed time in seconds since installation beggining |
| `progress` | dedicated.server.InstallationProgressSteps[] |  | Installation steps |
| `progress[].comment` | string |  | Informations about this installation step |
| `progress[].error` | string |  | Error details if state is error |
| `progress[].status` | dedicated.server.InstallationProgressStatusEnum |  | Status of this installation step — one of `doing`, `done`, `error`, `expired`, `idle`, `pending`, `stopping`, `todo` |

```json
{
  "elapsedTime": 0,
  "progress": [
    {
      "comment": "string",
      "error": "string",
      "status": "doing"
    }
  ]
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/install/status" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/install/status")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/install/status");

print_r($result);
?>
```

## List compatible netboots

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-boot

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:boot/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `bootType` | query | dedicated.server.BootTypeEnum |  | Filter the value of bootType property (=) — one of `harddisk`, `internal`, `network`, `power`, `rescue` |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | integer[] | successful operation |

```json
[
  0
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/boot")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/boot");

print_r($result);
?>
```

## Get a netboot

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-boot-bootid

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:boot/get`

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `bootId` | path | integer | yes | boot id |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.Netboot | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `bootId` | integer | read-only | boot id |
| `bootType` | dedicated.server.BootTypeEnum | read-only | the boot system — one of `harddisk`, `internal`, `network`, `power`, `rescue` |
| `description` | string | read-only | the boot description |
| `kernel` | string | read-only | The boot kernel |

```json
{
  "bootId": 0,
  "bootType": "harddisk",
  "description": "string",
  "kernel": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot/{bootId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/boot/{bootId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/boot/{bootId}");

print_r($result);
?>
```

## List netboot options

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-boot-bootid-option

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:boot/option/get`

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `bootId` | path | integer | yes | boot id |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.BootOptionEnum[] | successful operation |

```json
[
  "cpufamily"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot/{bootId}/option" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/boot/{bootId}/option")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/boot/{bootId}/option");

print_r($result);
?>
```

## Get a netboot option

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-servicename-boot-bootid-option-option

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:boot/option/get`

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `bootId` | path | integer | yes | boot id |
| `option` | path | dedicated.server.BootOptionEnum | yes | The option of this boot — one of `cpufamily`, `grsec`, `ipv6`, `smp` |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.netbootOption | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `option` | dedicated.server.BootOptionEnum | read-only | The option of this boot — one of `cpufamily`, `grsec`, `ipv6`, `smp` |
| `value` | string | read-only | the value of this option |

```json
{
  "option": "cpufamily",
  "value": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/boot/{bootId}/option/{option}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/{serviceName}/boot/{bootId}/option/{option}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/{serviceName}/boot/{bootId}/option/{option}");

print_r($result);
?>
```

## Reboot the server

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#post-dedicated-server-servicename-reboot

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh: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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.server.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `changeUuid` | string | read-only | UUID of the change linked to this task |
| `comment` | string | read-only | Details of this task |
| `doneDate` | string (date-time) | read-only | Completion date |
| `function` | dedicated.TaskFunctionEnum | read-only | Function name — one of `INFRA_002_VirtualNetworkInterface`, `INFRA_002_VirtualNetworkInterface_group`, `INFRA_002_VirtualNetworkInterface_ungroup`, `INFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_group`, `INFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroup`, `INFRA_ONE_NETWORK_VirtualNetworkInterface_group`, `INFRA_ONE_NETWORK_VirtualNetworkInterface_ungroup`, `addVirtualMac`, `addWindowSplaFromExistingSerial`, `applyBackupFtpAcls`, `applyBackupFtpQuota`, `bypassAntiDDosGame`, … |
| `lastUpdate` | string (date-time) | read-only | last update |
| `needSchedule` | boolean | read-only | Whether this task need to be scheduled or not |
| `note` | string | read-only | Extra information about this task |
| `plannedInterventionId` | integer | read-only | ID of the planned intervention for this task |
| `startDate` | string (date-time) | read-only | Task Creation date |
| `status` | dedicated.TaskStatusEnum | read-only | Task status — one of `cancelled`, `customerError`, `doing`, `done`, `init`, `ovhError`, `todo` |
| `tags` | complexType.SafeKeyValueCanBeNull_string[] | read-only | Task result tags output |
| `tags[].key` | string |  |  |
| `tags[].value` | string |  |  |
| `taskId` | integer | read-only | the id of the task |
| `ticketReference` | string | read-only | Reference of the thread on the support tool |

```json
{
  "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"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/reboot" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/dedicated/server/{serviceName}/reboot")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/dedicated/server/{serviceName}/reboot");

print_r($result);
?>
```

## List operating systems by hardware

`GET /1.0/dedicated/server/osAvailabilities`

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-server-osavailabilities

**Status:** Stable production version  
**Authentication:** none (public operation)

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `hardware` | query | string | yes | Hardware reference requested |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/osAvailabilities" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/server/osAvailabilities")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/server/osAvailabilities");

print_r($result);
?>
```

## List installation templates

`GET /1.0/dedicated/installationTemplate`

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate

**Status:** Stable production version  
**Authentication:** none (public operation)

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.

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate");

print_r($result);
?>
```

## List installation template details

`GET /1.0/dedicated/installationTemplate/templateInfos`

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templateinfos

**Status:** Stable production version  
**Authentication:** none (public operation)

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.

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.TemplateOsInfo[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category` | dedicated.TemplateOsUsageEnum |  | OS Category (also called OS usage) — one of `backup`, `basic`, `customer`, `database`, `erp`, `hosting`, `management`, `other`, `readyToUse`, `virtualisation`, `virtualization` |
| `description` | string |  | OS long name |
| `endOfInstall` | string (date) |  | OS template end of install at OVH date |
| `family` | dedicated.TemplateOsTypeEnum |  | OS family (also called OS type) — one of `bsd`, `custom`, `ibm`, `linux`, `solaris`, `unix`, `windows` |
| `license` | dedicated.TemplateOsInfoLicense |  | OS template license details |
| `license.os` | dedicated.TemplateOsInfoLicenseItem |  | OS template license OS details |
| `license.os.name` | dedicated.TemplateOsInfoLicenseItemEnum[] |  | OS template license item names |
| `license.os.url` | string |  | OS template license item url |
| `license.usage` | dedicated.TemplateOsInfoLicenseItem |  | OS template license usage details |
| `license.usage.name` | dedicated.TemplateOsInfoLicenseItemEnum[] |  | OS template license item names |
| `license.usage.url` | string |  | OS template license item url |
| `project` | dedicated.TemplateOsInfoProject |  | OS template project details |
| `project.os` | dedicated.TemplateOsInfoProjectItem |  | OS template project OS details |
| `project.os.governance` | string[] |  | OS template project item governance |
| `project.os.name` | string |  | OS template project item name |
| `project.os.releaseNotes` | string |  | OS template project item release notes |
| `project.os.url` | string |  | OS template project item url |
| `project.os.version` | string |  | OS template project item version |
| `project.usage` | dedicated.TemplateOsInfoProjectItem |  | OS template project usage details |
| `project.usage.governance` | string[] |  | OS template project item governance |
| `project.usage.name` | string |  | OS template project item name |
| `project.usage.releaseNotes` | string |  | OS template project item release notes |
| `project.usage.url` | string |  | OS template project item url |
| `project.usage.version` | string |  | OS template project item version |
| `subfamily` | dedicated.TemplateOsSubfamilyEnum |  | OS subfamily — one of `alma`, `aos`, `arch`, `byoi`, `byolinux`, `centos`, `cloudlinux`, `coreos`, `debian`, `dgx`, `esxi`, `fedora`, … |
| `templateName` | string |  | OS template name |

```json
[
  {
    "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"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/templateInfos" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/templateInfos")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/templateInfos");

print_r($result);
?>
```

## Get an installation template

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename

**Status:** Stable production version  
**Authentication:** none (public operation)

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.installationTemplate.Templates | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `bitFormat` | dedicated.server.BitFormatEnum | read-only | this template bit format — one of `32`, `64` |
| `category` | dedicated.TemplateOsUsageEnum | read-only | category of this template (informative only) — one of `backup`, `basic`, `customer`, `database`, `erp`, `hosting`, `management`, `other`, `readyToUse`, `virtualisation`, `virtualization` |
| `description` | string | read-only | information about this template |
| `distribution` | string | read-only | the distribution this template is based on |
| `endOfInstall` | string (date) | read-only | after this date, install of this template will not be possible at OVH |
| `family` | dedicated.TemplateOsTypeEnum | read-only | this template family type — one of `bsd`, `custom`, `ibm`, `linux`, `solaris`, `unix`, `windows` |
| `filesystems` | dedicated.server.FileSystemEnum[] | read-only | list of all filesystems available for this template |
| `inputs` | dedicated.TemplateOsInput[] | read-only | Inputs |
| `inputs[].default` | string |  | Default value |
| `inputs[].description` | string |  | Input question description |
| `inputs[].enum` | string[] |  | When type is enum: name of the possible enum values |
| `inputs[].mandatory` | boolean |  | Whether answering to that question is mandatory in order to trigger an install with that specific OS or not |
| `inputs[].name` | string |  | Input question name |
| `inputs[].type` | dedicated.TemplateOsInputTypeEnum |  | Input type — one of `boolean`, `date`, `email`, `enum`, `hexstring`, `hostname`, `ip`, `keyValue`, `number`, `sshPubKey`, `string`, `text`, … |
| `license` | dedicated.TemplateOsInfoLicense | read-only | This distribution licensing details |
| `license.os` | dedicated.TemplateOsInfoLicenseItem |  | OS template license OS details |
| `license.os.name` | dedicated.TemplateOsInfoLicenseItemEnum[] |  | OS template license item names |
| `license.os.url` | string |  | OS template license item url |
| `license.usage` | dedicated.TemplateOsInfoLicenseItem |  | OS template license usage details |
| `license.usage.name` | dedicated.TemplateOsInfoLicenseItemEnum[] |  | OS template license item names |
| `license.usage.url` | string |  | OS template license item url |
| `lvmReady` | boolean | read-only | This distribution supports Logical Volumes (Linux LVM) |
| `noPartitioning` | boolean | read-only | Partitioning customization is not available for this OS template |
| `project` | dedicated.TemplateOsInfoProject | read-only | This distribution project details |
| `project.os` | dedicated.TemplateOsInfoProjectItem |  | OS template project OS details |
| `project.os.governance` | string[] |  | OS template project item governance |
| `project.os.name` | string |  | OS template project item name |
| `project.os.releaseNotes` | string |  | OS template project item release notes |
| `project.os.url` | string |  | OS template project item url |
| `project.os.version` | string |  | OS template project item version |
| `project.usage` | dedicated.TemplateOsInfoProjectItem |  | OS template project usage details |
| `project.usage.governance` | string[] |  | OS template project item governance |
| `project.usage.name` | string |  | OS template project item name |
| `project.usage.releaseNotes` | string |  | OS template project item release notes |
| `project.usage.url` | string |  | OS template project item url |
| `project.usage.version` | string |  | OS template project item version |
| `rootMountpoint` | string | read-only | The mandatory mount point of the root filesystem on this OS |
| `softRaidOnlyMirroring` | boolean | read-only | Partitioning customization is available but limited to mirroring for this OS template |
| `subfamily` | dedicated.TemplateOsSubfamilyEnum | read-only | this template subfamily type — one of `alma`, `aos`, `arch`, `byoi`, `byolinux`, `centos`, `cloudlinux`, `coreos`, `debian`, `dgx`, `esxi`, `fedora`, … |
| `templateName` | string | read-only | This template name |

```json
{
  "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"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}");

print_r($result);
?>
```

## List partitioning schemes

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename-partitionscheme

**Status:** Stable production version  
**IAM actions:** `account:apiovh:dedicatedInstallationTemplate/partitionScheme/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}/partitionScheme")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}/partitionScheme");

print_r($result);
?>
```

## Get a partitioning scheme

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename-partitionscheme-schemename

**Status:** Stable production version  
**IAM actions:** `account:apiovh:dedicatedInstallationTemplate/partitionScheme/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `schemeName` | path | string | yes | This partitioning scheme name |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.installationTemplate.templatePartitioningSchemes | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | read-only | This partitioning scheme name |
| `priority` | integer | read-only | 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) |

```json
{
  "name": "string",
  "priority": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}");

print_r($result);
?>
```

## List hardware RAIDs

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename-partitionscheme-schemename-hardwareraid

**Status:** Stable production version  
**IAM actions:** `account:apiovh:dedicatedInstallationTemplate/partitionScheme/hardwareRaid/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `schemeName` | path | string | yes | This partitioning scheme name |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid");

print_r($result);
?>
```

## Get a hardware RAID

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename-partitionscheme-schemename-hardwareraid-name

**Status:** Stable production version  
**IAM actions:** `account:apiovh:dedicatedInstallationTemplate/partitionScheme/hardwareRaid/get`

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

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `name` | path | string | yes | Hardware RAID name |
| `schemeName` | path | string | yes | This partitioning scheme name |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.installationTemplate.hardwareRaid | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `disks` | string[] | read-only | Disk list |
| `mode` | dedicated.TemplateOsHardwareRaidEnum | read-only | RAID mode — one of `raid0`, `raid1`, `raid10`, `raid5`, `raid50`, `raid6`, `raid60` |
| `name` | string | read-only | Hardware RAID name |
| `step` | integer | read-only | Specifies the creation order of the hardware RAID |

```json
{
  "disks": [
    "string"
  ],
  "mode": "raid0",
  "name": "string",
  "step": 0
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}");

print_r($result);
?>
```

## List partitions

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename-partitionscheme-schemename-partition

**Status:** Stable production version  
**IAM actions:** `account:apiovh:dedicatedInstallationTemplate/partitionScheme/partition/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `schemeName` | path | string | yes | This partitioning scheme name |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition");

print_r($result);
?>
```

## Get a partition

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

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/deployments/#get-dedicated-installationtemplate-templatename-partitionscheme-schemename-partition-mountpoint

**Status:** Stable production version  
**IAM actions:** `account:apiovh:dedicatedInstallationTemplate/partitionScheme/partition/get`

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.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `mountpoint` | path | string | yes | Partition mount point |
| `schemeName` | path | string | yes | This partitioning scheme name |
| `templateName` | path | string | yes | This template name |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.installationTemplate.templatePartitions | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filesystem` | dedicated.server.FileSystemEnum | read-only | Partition filesytem — one of `btrfs`, `ext3`, `ext4`, `fat16`, `none`, `ntfs`, `reiserfs`, `swap`, `ufs`, `vmfs5`, `vmfs6`, `vmfsl`, … |
| `mountpoint` | string | read-only | Partition mount point |
| `order` | integer | read-only | specifies the creation order of the partition on the disk |
| `raid` | dedicated.server.PartitionRaidEnum | read-only | Partition raid — one of `0`, `1`, `10`, `5`, `6`, `7` |
| `size` | complexType.UnitAndValue_long | read-only | Partition size (unit: MB GB TB, MB by default), 0 => rest of the space |
| `size.unit` | string |  |  |
| `size.value` | integer |  |  |
| `type` | dedicated.TemplatePartitionTypeEnum | read-only | Partition type — one of `logical`, `lv`, `primary` |
| `volumeName` | string | read-only | Logical volume name (required if type is lv) or optional zpool name if filesystem is ZFS |

```json
{
  "filesystem": "btrfs",
  "mountpoint": "string",
  "order": 0,
  "raid": "0",
  "size": {
    "unit": "string",
    "value": 0
  },
  "type": "logical",
  "volumeName": "string"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}");

print_r($result);
?>
```