# Bare Metal Cloud › Dedicated Servers › System 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

> 13 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/system/

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

## Operations

- `GET /dedicated/server/{serviceName}/biosSettings` — Get the BIOS settings
- `GET /dedicated/server/{serviceName}/biosSettings/sgx` — Get the SGX settings
- `POST /dedicated/server/{serviceName}/biosSettings/sgx/configure` — Configure SGX
- `GET /dedicated/server/{serviceName}/license/compliantWindows` — List compliant Windows licenses
- `GET /dedicated/server/{serviceName}/license/compliantWindowsSqlServer` — List compliant SQL Server licenses
- `POST /dedicated/server/{serviceName}/license/windows` — Add an existing Windows license
- `GET /dedicated/server/{serviceName}/spla` — List SPLA licenses
- `POST /dedicated/server/{serviceName}/spla` — Add an SPLA license
- `GET /dedicated/server/{serviceName}/spla/{id}` — Get an SPLA license
- `PUT /dedicated/server/{serviceName}/spla/{id}` — Update an SPLA license
- `POST /dedicated/server/{serviceName}/spla/{id}/revoke` — Revoke an SPLA license
- `GET /dedicated/server/{serviceName}/plannedChange` — List planned changes
- `GET /dedicated/server/{serviceName}/plannedChange/{changeUuid}` — Get a planned change

## Get the BIOS settings

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

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

**Status:** Beta version  
**IAM actions:** `dedicatedServer:apiovh:biosSettings/get`

Get the BIOS settings. Returns the configurable BIOS settings of the server. The response states whether SGX is supported and lists the SGX statuses and PRMRR sizes the server accepts.

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.biosSettings.BiosSettings | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `supportedSettings` | dedicated.server.BiosSettingsSupport | read-only | List supported setting |
| `supportedSettings.sgx` | boolean |  | SGX feature support |
| `supportedSettings.sgxOptions` | dedicated.server.BiosSettingsSupportSgxOptions |  | Supported SGX options |
| `supportedSettings.sgxOptions.prmrr` | dedicated.server.BiosSettingsSgxPrmrrEnum[] |  | Supported SGX prmrr values |
| `supportedSettings.sgxOptions.status` | dedicated.server.BiosSettingsSgxStatusEnum[] |  | Supported SGX statuses |

```json
{
  "supportedSettings": {
    "sgx": true,
    "sgxOptions": {
      "prmrr": [
        "128"
      ],
      "status": [
        "disabled"
      ]
    }
  }
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/biosSettings" \
  -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}/biosSettings")

# 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}/biosSettings");

print_r($result);
?>
```

## Get the SGX settings

`GET /1.0/dedicated/server/{serviceName}/biosSettings/sgx`

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

**Status:** Beta version  
**IAM actions:** `dedicatedServer:apiovh:biosSettings/sgx/get`

Get the SGX settings. Returns the SGX configuration of the server: the SGX status and the size of the Processor Reserved Memory (PRMRR). To change it, use the configure operation.

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicated.biosSettingsSgx.BiosSettingsSgx | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `prmrr` | dedicated.server.BiosSettingsSgxPrmrrEnum | read-only | Settings sections — one of `128`, `131072`, `16384`, `2048`, `256`, `32`, `32768`, `4096`, `512`, `64`, `65536`, `8192` |
| `status` | dedicated.server.BiosSettingsSgxStatusEnum | read-only | Settings sections — one of `disabled`, `enabled`, `software controlled` |

```json
{
  "prmrr": "128",
  "status": "disabled"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/biosSettings/sgx" \
  -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}/biosSettings/sgx")

# 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}/biosSettings/sgx");

print_r($result);
?>
```

## Configure SGX

`POST /1.0/dedicated/server/{serviceName}/biosSettings/sgx/configure`

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/system/#post-dedicated-server-servicename-biossettings-sgx-configure

**Status:** Beta version  
**IAM actions:** `dedicatedServer:apiovh:biosSettings/sgx/configure`

Configure SGX. Enables or disables SGX and sets the size of the Processor Reserved Memory (PRMRR). The server reboots one or several times. On a server without SGX BIOS settings, the call returns an error.

### Parameters

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

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `prmrr` | dedicated.server.BiosSettingsSgxPrmrrEnum |  | Size of the Processor Reserved Memory — one of `128`, `131072`, `16384`, `2048`, `256`, `32`, `32768`, `4096`, `512`, `64`, `65536`, `8192` |
| `status` | dedicated.server.BiosSettingsSgxStatusEnum |  | Desired SGX status — one of `disabled`, `enabled`, `software controlled` |

```json
{
  "prmrr": "128",
  "status": "disabled"
}
```

### 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}/biosSettings/sgx/configure" \
  -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
)

result = client.post("/dedicated/server/{serviceName}/biosSettings/sgx/configure",
	prmrr = None, # Size of the Processor Reserved Memory (type: dedicated.server.BiosSettingsSgxPrmrrEnum, nullable)
	status = None, # Desired SGX status (type: dedicated.server.BiosSettingsSgxStatusEnum, nullable)
)

# 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}/biosSettings/sgx/configure", array(
	prmrr => null, // Size of the Processor Reserved Memory (type: dedicated.server.BiosSettingsSgxPrmrrEnum, nullable)
	status => null, // Desired SGX status (type: dedicated.server.BiosSettingsSgxStatusEnum, nullable)
));

print_r($result);
?>
```

## List compliant Windows licenses

`GET /1.0/dedicated/server/{serviceName}/license/compliantWindows`

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

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

List compliant Windows licenses. Returns the Windows license versions compliant with the server, as a list of version names.

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | license.WindowsOsVersionEnum[] | successful operation |

```json
[
  "WINDOWS_SERVER_2003_ENTERPRISE_EDITION"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/license/compliantWindows" \
  -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}/license/compliantWindows")

# 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}/license/compliantWindows");

print_r($result);
?>
```

## List compliant SQL Server licenses

`GET /1.0/dedicated/server/{serviceName}/license/compliantWindowsSqlServer`

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

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

List compliant SQL Server licenses. Returns the Windows SQL Server license versions compliant with the server, as a list of version names.

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | license.WindowsSqlVersionEnum[] | successful operation |

```json
[
  "SQL_SERVER_2008_STANDARD_EDITION"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/license/compliantWindowsSqlServer" \
  -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}/license/compliantWindowsSqlServer")

# 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}/license/compliantWindowsSqlServer");

print_r($result);
?>
```

## Add an existing Windows license

`POST /1.0/dedicated/server/{serviceName}/license/windows`

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

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:license/windows/create`

Add an existing Windows license. Attaches an existing Windows license serial number to the server, for the given license version. The license can then be managed under /license/windows. Returns a task.

### Parameters

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

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `licenseId` | string | yes | Your license serial number |
| `version` | license.WindowsOsVersionEnum | yes | Your license version — one of `WINDOWS_SERVER_2003_ENTERPRISE_EDITION`, `WINDOWS_SERVER_2003_ENTERPRISE_EDITION_2_CPU`, `WINDOWS_SERVER_2003_STANDARD_EDITION`, `WINDOWS_SERVER_2003_WEB_EDITION`, `WINDOWS_SERVER_2003_WEB_EDITION_2_CPU`, `WINDOWS_SERVER_2003_WEB_ENHANCED_EDITION`, `WINDOWS_SERVER_2003_WEB_STANDARD_EDITION`, `WINDOWS_SERVER_2003_WEB_STANDARD_EDITION_2_CPU`, `WINDOWS_SERVER_2008_DATACENTER_EDITION`, `WINDOWS_SERVER_2008_DATACENTER_EDITION_2_CPU`, `WINDOWS_SERVER_2008_DATACENTER_EDITION_4_CPU`, `WINDOWS_SERVER_2008_ENTERPRISE_EDITION`, … |

```json
{
  "licenseId": "string",
  "version": "WINDOWS_SERVER_2003_ENTERPRISE_EDITION"
}
```

### 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}/license/windows" \
  -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
)

result = client.post("/dedicated/server/{serviceName}/license/windows",
	licenseId = None, # Your license serial number (type: string)
	version = None, # Your license version (type: license.WindowsOsVersionEnum)
)

# 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}/license/windows", array(
	licenseId => null, // Your license serial number (type: string)
	version => null, // Your license version (type: license.WindowsOsVersionEnum)
));

print_r($result);
?>
```

## List SPLA licenses

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

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

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

List SPLA licenses. Returns the IDs of your own SPLA licenses attached to the server. The list can be filtered by status and by license type.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | The internal name of your dedicated server |
| `status` | query | dedicated.server.SplaStatusEnum |  | Filter the value of status property (=) — one of `terminated`, `used`, `waitingToCheck` |
| `type` | query | dedicated.server.SplaTypeEnum |  | Filter the value of type property (=) — one of `os`, `sqlstd`, `sqlweb` |

### 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}/spla" \
  -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}/spla")

# 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}/spla");

print_r($result);
?>
```

## Add an SPLA license

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

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

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:spla/create`

Add an SPLA license. Attaches an SPLA license to the server from its serial number and its type: os, sqlstd or sqlweb. Returns the ID of the new license.

### Parameters

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

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `serialNumber` | string | yes | License serial number |
| `type` | dedicated.server.SplaTypeEnum | yes | License type — one of `os`, `sqlstd`, `sqlweb` |

```json
{
  "serialNumber": "string",
  "type": "os"
}
```

### Responses

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

```json
0
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla" \
  -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
)

result = client.post("/dedicated/server/{serviceName}/spla",
	serialNumber = None, # License serial number (type: string)
	type = None, # License type (type: dedicated.server.SplaTypeEnum)
)

# 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}/spla", array(
	serialNumber => null, // License serial number (type: string)
	type => null, // License type (type: dedicated.server.SplaTypeEnum)
));

print_r($result);
?>
```

## Get an SPLA license

`GET /1.0/dedicated/server/{serviceName}/spla/{id}`

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

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

Get an SPLA license. Returns an SPLA license attached to the server: its serial number, type, status and last update date. The status is waitingToCheck, used or terminated.

### Parameters

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

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | read-only | License id |
| `lastUpdate` | string (date-time) | read-only | Last update timestamp |
| `serialNumber` | string |  | License serial number |
| `status` | dedicated.server.SplaStatusEnum | read-only | Status of license — one of `terminated`, `used`, `waitingToCheck` |
| `type` | dedicated.server.SplaTypeEnum | read-only | License type — one of `os`, `sqlstd`, `sqlweb` |

```json
{
  "id": 0,
  "lastUpdate": "2024-01-01T12:00:00Z",
  "serialNumber": "string",
  "status": "terminated",
  "type": "os"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla/{id}" \
  -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}/spla/{id}")

# 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}/spla/{id}");

print_r($result);
?>
```

## Update an SPLA license

`PUT /1.0/dedicated/server/{serviceName}/spla/{id}`

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/system/#put-dedicated-server-servicename-spla-id

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:spla/edit`

Update an SPLA license. Updates the serial number of an SPLA license. The serial number is the only writable field of the license.

### Parameters

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

### Request body (required)

Type: `dedicated.server.spla`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer | read-only | License id |
| `lastUpdate` | string (date-time) | read-only | Last update timestamp |
| `serialNumber` | string |  | License serial number |
| `status` | dedicated.server.SplaStatusEnum | read-only | Status of license — one of `terminated`, `used`, `waitingToCheck` |
| `type` | dedicated.server.SplaTypeEnum | read-only | License type — one of `os`, `sqlstd`, `sqlweb` |

```json
{
  "serialNumber": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla/{id}" \
  -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.spla
result = client.put("/dedicated/server/{serviceName}/spla/{id}",
	serialNumber = None, # License serial number (type: string)
)

# 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.spla
$result = $ovh->put("/dedicated/server/{serviceName}/spla/{id}", array(
	serialNumber => null, // License serial number (type: string)
));

print_r($result);
?>
```

## Revoke an SPLA license

`POST /1.0/dedicated/server/{serviceName}/spla/{id}/revoke`

Link: https://developers.eu.ovhcloud.com/reference/bare-metal-cloud/dedicated-servers/system/#post-dedicated-server-servicename-spla-id-revoke

**Status:** Stable production version  
**IAM actions:** `dedicatedServer:apiovh:spla/revoke`

Revoke an SPLA license. Revokes an SPLA license attached to the server, identified by its license ID. The call returns no content.

### Parameters

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

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla/{id}/revoke" \
  -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}/spla/{id}/revoke")

# 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}/spla/{id}/revoke");

print_r($result);
?>
```

## List planned changes

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

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

**Status:** Beta version  
**IAM actions:** `dedicatedServer:apiovh:plannedChange/get`

List planned changes. Returns the UUIDs of the changes planned on the server. Get a change by its UUID to read its purpose, status and expected dates.

### Parameters

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

### 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}/plannedChange" \
  -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}/plannedChange")

# 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}/plannedChange");

print_r($result);
?>
```

## Get a planned change

`GET /1.0/dedicated/server/{serviceName}/plannedChange/{changeUuid}`

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

**Status:** Beta version  
**IAM actions:** `dedicatedServer:apiovh:plannedChange/get`

Get a planned change. Returns a change planned on the server: its purpose, its status, its wanted start date and its expected end date.

### Parameters

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

### Responses

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `expectedEndDate` | string (date-time) | read-only | Expected end date for this change |
| `id` | string | read-only | UUID of the change |
| `status` | dedicated.PlannedChangeStatusEnum | read-only | Status of the change — one of `acknowledged`, `assess`, `authorize`, `canceled`, `closed`, `doing`, `done`, `implement`, `new`, `review`, `scheduled`, `todo` |
| `type` | dedicated.PlannedInterventionTypeEnum | read-only | Operation purpose — one of `HARDWARE_UPGRADE_ON_ACTIVE_SERVER` |
| `wantedStartDate` | string (date-time) | read-only | Wanted start date for this change |

```json
{
  "expectedEndDate": "2024-01-01T12:00:00Z",
  "id": "string",
  "status": "acknowledged",
  "type": "HARDWARE_UPGRADE_ON_ACTIVE_SERVER",
  "wantedStartDate": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/plannedChange/{changeUuid}" \
  -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}/plannedChange/{changeUuid}")

# 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}/plannedChange/{changeUuid}");

print_r($result);
?>
```