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

System

All operations require authentication.

13 operationsv1/dedicated/server
OpenAPI
Agent setup

Get the BIOS settingsBeta

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

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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200BiosSettingssuccessful operation
supportedSettings
read-only
BiosSettingsSupport

List supported setting

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/biosSettings \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "supportedSettings": {    "sgx": true,    "sgxOptions": {      "prmrr": [        "128"      ],      "status": [        "disabled"      ]    }  }}

Get the SGX settingsBeta

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

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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200BiosSettingsSgxsuccessful operation
prmrr
read-only
BiosSettingsSgxPrmrrEnum

Settings sections

Values1281310721638420482563232768409651264655368192
status
read-only
BiosSettingsSgxStatusEnum

Settings sections

Valuesdisabledenabledsoftware controlled

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/biosSettings/sgx \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "prmrr": "128",  "status": "disabled"}

Configure SGXBeta

POST
/1.0/dedicated/server/{serviceName}/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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

prmrr
BiosSettingsSgxPrmrrEnum

Size of the Processor Reserved Memory

Values1281310721638420482563232768409651264655368192
status
BiosSettingsSgxStatusEnum

Desired SGX status

Valuesdisabledenabledsoftware controlled

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

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

List compliant Windows licensesProduction

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

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

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200WindowsOsVersionEnum[]successful operation

Example uses serviceName = string

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

List compliant SQL Server licensesProduction

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

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

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200WindowsSqlVersionEnum[]successful operation

Example uses serviceName = string

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

Add an existing Windows licenseProduction

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

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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

licenseId
required
string

Your license serial number

version
required
WindowsOsVersionEnum

Your license version

ValuesWINDOWS_SERVER_2003_ENTERPRISE_EDITIONWINDOWS_SERVER_2003_ENTERPRISE_EDITION_2_CPUWINDOWS_SERVER_2003_STANDARD_EDITIONWINDOWS_SERVER_2003_WEB_EDITIONWINDOWS_SERVER_2003_WEB_EDITION_2_CPUWINDOWS_SERVER_2003_WEB_ENHANCED_EDITIONWINDOWS_SERVER_2003_WEB_STANDARD_EDITIONWINDOWS_SERVER_2003_WEB_STANDARD_EDITION_2_CPUWINDOWS_SERVER_2008_DATACENTER_EDITIONWINDOWS_SERVER_2008_DATACENTER_EDITION_2_CPUWINDOWS_SERVER_2008_DATACENTER_EDITION_4_CPUWINDOWS_SERVER_2008_ENTERPRISE_EDITIONWINDOWS_SERVER_2008_ENTERPRISE_EDITION_2_CPUWINDOWS_SERVER_2008_ENTERPRISE_EDITION_4_CPUWINDOWS_SERVER_2008_STANDARD_EDITIONWINDOWS_SERVER_2008_STANDARD_EDITION_2_CPUWINDOWS_SERVER_2008_STANDARD_EDITION_4_CPUWINDOWS_SERVER_2008_WEB_EDITIONWINDOWS_SERVER_2008_WEB_EDITION_2_CPUWINDOWS_SERVER_2008_WEB_EDITION_4_CPUWINDOWS_SERVER_2008_WEB_STANDARD_EDITIONWINDOWS_SERVER_2012_DATACENTER_EDITIONWINDOWS_SERVER_2012_DATACENTER_EDITION_2_CPUWINDOWS_SERVER_2012_DATACENTER_EDITION_4_CPUWINDOWS_SERVER_2012_ENTERPRISE_EDITIONWINDOWS_SERVER_2012_ENTERPRISE_EDITION_2_CPUWINDOWS_SERVER_2012_STANDARD_EDITIONWINDOWS_SERVER_2012_STANDARD_EDITION_2_CPUWINDOWS_SERVER_2012_STANDARD_EDITION_4_CPUWINDOWS_SERVER_2012_WEB_EDITIONWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_10_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_12_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_14_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_16_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_18_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_20_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_22_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_24_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_32_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_48_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_64_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_1_CPU_8_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_10_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_12_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_14_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_16_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_18_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_20_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_22_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_24_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_32_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_2_CPU_8_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_10_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_12_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_14_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_16_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_18_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_20_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_22_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_24_CORESWINDOWS_SERVER_2016_DATACENTER_EDITION_4_CPU_8_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_10_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_12_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_14_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_16_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_18_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_20_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_22_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_24_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_32_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_48_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_64_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_1_CPU_8_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_10_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_12_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_14_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_16_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_18_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_20_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_22_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_24_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_32_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_2_CPU_8_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_10_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_12_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_14_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_16_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_18_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_20_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_22_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_24_CORESWINDOWS_SERVER_2016_STANDARD_EDITION_4_CPU_8_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_10_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_128_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_12_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_14_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_16_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_18_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_192_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_20_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_22_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_24_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_256_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_26_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_28_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_30_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_32_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_34_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_36_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_38_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_40_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_42_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_44_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_46_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_48_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_50_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_512_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_52_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_54_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_56_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_58_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_60_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_62_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_64_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_72_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_8_CORESWINDOWS_SERVER_2019_DATACENTER_EDITION_96_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_10_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_128_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_12_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_14_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_16_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_18_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_192_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_20_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_22_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_24_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_256_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_26_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_28_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_30_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_32_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_34_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_36_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_38_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_40_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_42_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_44_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_46_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_48_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_50_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_512_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_52_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_54_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_56_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_58_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_60_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_62_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_64_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_72_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_8_CORESWINDOWS_SERVER_2019_STANDARD_EDITION_96_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_10_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_128_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_12_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_14_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_16_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_18_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_192_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_20_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_22_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_24_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_256_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_26_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_28_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_30_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_32_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_34_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_36_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_38_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_40_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_42_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_44_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_46_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_48_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_50_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_512_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_52_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_54_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_56_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_58_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_60_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_62_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_64_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_72_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_8_CORESWINDOWS_SERVER_2022_DATACENTER_EDITION_96_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_10_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_128_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_12_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_14_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_16_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_18_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_192_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_20_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_22_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_24_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_256_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_26_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_28_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_30_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_32_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_34_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_36_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_38_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_40_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_42_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_44_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_46_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_48_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_50_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_512_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_52_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_54_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_56_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_58_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_60_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_62_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_64_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_72_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_8_CORESWINDOWS_SERVER_2022_STANDARD_EDITION_96_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_10_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_128_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_12_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_14_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_16_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_18_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_192_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_20_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_22_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_24_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_256_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_26_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_28_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_30_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_32_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_34_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_36_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_38_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_40_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_42_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_44_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_46_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_48_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_50_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_512_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_52_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_54_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_56_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_58_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_60_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_62_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_64_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_72_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_8_CORESWINDOWS_SERVER_2025_DATACENTER_EDITION_96_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_10_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_128_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_12_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_14_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_16_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_18_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_192_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_20_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_22_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_24_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_256_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_26_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_28_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_30_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_32_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_34_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_36_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_38_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_40_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_42_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_44_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_46_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_48_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_50_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_512_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_52_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_54_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_56_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_58_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_60_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_62_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_64_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_72_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_8_CORESWINDOWS_SERVER_2025_STANDARD_EDITION_96_CORESwindows-server-2008-license-datacenter-edition-1-cpuwindows-server-2008-license-datacenter-edition-2-cpuwindows-server-2008-license-datacenter-edition-4-cpuwindows-server-2008-license-enterprise-edition-1-cpuwindows-server-2008-license-enterprise-edition-2-cpuwindows-server-2008-license-enterprise-edition-4-cpuwindows-server-2008-license-standard-edition-1-cpuwindows-server-2008-license-standard-edition-2-cpuwindows-server-2008-license-standard-edition-4-cpuwindows-server-2008-license-web-edition-1-cpuwindows-server-2008-license-web-edition-2-cpuwindows-server-2008-license-web-edition-4-cpuwindows-server-2012-license-datacenter-edition-1-cpuwindows-server-2012-license-datacenter-edition-2-cpuwindows-server-2012-license-datacenter-edition-4-cpuwindows-server-2012-license-standard-edition-1-cpuwindows-server-2012-license-standard-edition-2-cpuwindows-server-2012-license-standard-edition-4-cpuwindows-server-2016-license-datacenter-edition-1-cpu-10-coreswindows-server-2016-license-datacenter-edition-1-cpu-12-coreswindows-server-2016-license-datacenter-edition-1-cpu-14-coreswindows-server-2016-license-datacenter-edition-1-cpu-16-coreswindows-server-2016-license-datacenter-edition-1-cpu-18-coreswindows-server-2016-license-datacenter-edition-1-cpu-20-coreswindows-server-2016-license-datacenter-edition-1-cpu-22-coreswindows-server-2016-license-datacenter-edition-1-cpu-24-coreswindows-server-2016-license-datacenter-edition-1-cpu-32-coreswindows-server-2016-license-datacenter-edition-1-cpu-48-coreswindows-server-2016-license-datacenter-edition-1-cpu-64-coreswindows-server-2016-license-datacenter-edition-1-cpu-8-coreswindows-server-2016-license-datacenter-edition-2-cpu-10-coreswindows-server-2016-license-datacenter-edition-2-cpu-12-coreswindows-server-2016-license-datacenter-edition-2-cpu-14-coreswindows-server-2016-license-datacenter-edition-2-cpu-16-coreswindows-server-2016-license-datacenter-edition-2-cpu-18-coreswindows-server-2016-license-datacenter-edition-2-cpu-20-coreswindows-server-2016-license-datacenter-edition-2-cpu-22-coreswindows-server-2016-license-datacenter-edition-2-cpu-24-coreswindows-server-2016-license-datacenter-edition-2-cpu-32-coreswindows-server-2016-license-datacenter-edition-2-cpu-8-coreswindows-server-2016-license-datacenter-edition-4-cpu-10-coreswindows-server-2016-license-datacenter-edition-4-cpu-12-coreswindows-server-2016-license-datacenter-edition-4-cpu-14-coreswindows-server-2016-license-datacenter-edition-4-cpu-16-coreswindows-server-2016-license-datacenter-edition-4-cpu-18-coreswindows-server-2016-license-datacenter-edition-4-cpu-20-coreswindows-server-2016-license-datacenter-edition-4-cpu-22-coreswindows-server-2016-license-datacenter-edition-4-cpu-24-coreswindows-server-2016-license-datacenter-edition-4-cpu-8-coreswindows-server-2016-license-standard-edition-1-cpu-10-coreswindows-server-2016-license-standard-edition-1-cpu-12-coreswindows-server-2016-license-standard-edition-1-cpu-14-coreswindows-server-2016-license-standard-edition-1-cpu-16-coreswindows-server-2016-license-standard-edition-1-cpu-18-coreswindows-server-2016-license-standard-edition-1-cpu-20-coreswindows-server-2016-license-standard-edition-1-cpu-22-coreswindows-server-2016-license-standard-edition-1-cpu-24-coreswindows-server-2016-license-standard-edition-1-cpu-32-coreswindows-server-2016-license-standard-edition-1-cpu-48-coreswindows-server-2016-license-standard-edition-1-cpu-64-coreswindows-server-2016-license-standard-edition-1-cpu-8-coreswindows-server-2016-license-standard-edition-2-cpu-10-coreswindows-server-2016-license-standard-edition-2-cpu-12-coreswindows-server-2016-license-standard-edition-2-cpu-14-coreswindows-server-2016-license-standard-edition-2-cpu-16-coreswindows-server-2016-license-standard-edition-2-cpu-18-coreswindows-server-2016-license-standard-edition-2-cpu-20-coreswindows-server-2016-license-standard-edition-2-cpu-22-coreswindows-server-2016-license-standard-edition-2-cpu-24-coreswindows-server-2016-license-standard-edition-2-cpu-32-coreswindows-server-2016-license-standard-edition-2-cpu-8-coreswindows-server-2016-license-standard-edition-4-cpu-10-coreswindows-server-2016-license-standard-edition-4-cpu-12-coreswindows-server-2016-license-standard-edition-4-cpu-14-coreswindows-server-2016-license-standard-edition-4-cpu-16-coreswindows-server-2016-license-standard-edition-4-cpu-18-coreswindows-server-2016-license-standard-edition-4-cpu-20-coreswindows-server-2016-license-standard-edition-4-cpu-22-coreswindows-server-2016-license-standard-edition-4-cpu-24-coreswindows-server-2016-license-standard-edition-4-cpu-8-coreswindows-server-2019-license-datacenter-edition-10-coreswindows-server-2019-license-datacenter-edition-12-coreswindows-server-2019-license-datacenter-edition-128-coreswindows-server-2019-license-datacenter-edition-14-coreswindows-server-2019-license-datacenter-edition-16-coreswindows-server-2019-license-datacenter-edition-18-coreswindows-server-2019-license-datacenter-edition-192-coreswindows-server-2019-license-datacenter-edition-20-coreswindows-server-2019-license-datacenter-edition-22-coreswindows-server-2019-license-datacenter-edition-24-coreswindows-server-2019-license-datacenter-edition-256-coreswindows-server-2019-license-datacenter-edition-26-coreswindows-server-2019-license-datacenter-edition-28-coreswindows-server-2019-license-datacenter-edition-30-coreswindows-server-2019-license-datacenter-edition-32-coreswindows-server-2019-license-datacenter-edition-34-coreswindows-server-2019-license-datacenter-edition-36-coreswindows-server-2019-license-datacenter-edition-38-coreswindows-server-2019-license-datacenter-edition-40-coreswindows-server-2019-license-datacenter-edition-42-coreswindows-server-2019-license-datacenter-edition-44-coreswindows-server-2019-license-datacenter-edition-46-coreswindows-server-2019-license-datacenter-edition-48-coreswindows-server-2019-license-datacenter-edition-50-coreswindows-server-2019-license-datacenter-edition-512-coreswindows-server-2019-license-datacenter-edition-52-coreswindows-server-2019-license-datacenter-edition-54-coreswindows-server-2019-license-datacenter-edition-56-coreswindows-server-2019-license-datacenter-edition-58-coreswindows-server-2019-license-datacenter-edition-60-coreswindows-server-2019-license-datacenter-edition-62-coreswindows-server-2019-license-datacenter-edition-64-coreswindows-server-2019-license-datacenter-edition-72-coreswindows-server-2019-license-datacenter-edition-8-coreswindows-server-2019-license-datacenter-edition-96-coreswindows-server-2019-license-standard-edition-10-coreswindows-server-2019-license-standard-edition-12-coreswindows-server-2019-license-standard-edition-128-coreswindows-server-2019-license-standard-edition-14-coreswindows-server-2019-license-standard-edition-16-coreswindows-server-2019-license-standard-edition-18-coreswindows-server-2019-license-standard-edition-192-coreswindows-server-2019-license-standard-edition-20-coreswindows-server-2019-license-standard-edition-22-coreswindows-server-2019-license-standard-edition-24-coreswindows-server-2019-license-standard-edition-256-coreswindows-server-2019-license-standard-edition-26-coreswindows-server-2019-license-standard-edition-28-coreswindows-server-2019-license-standard-edition-30-coreswindows-server-2019-license-standard-edition-32-coreswindows-server-2019-license-standard-edition-34-coreswindows-server-2019-license-standard-edition-36-coreswindows-server-2019-license-standard-edition-38-coreswindows-server-2019-license-standard-edition-40-coreswindows-server-2019-license-standard-edition-42-coreswindows-server-2019-license-standard-edition-44-coreswindows-server-2019-license-standard-edition-46-coreswindows-server-2019-license-standard-edition-48-coreswindows-server-2019-license-standard-edition-50-coreswindows-server-2019-license-standard-edition-512-coreswindows-server-2019-license-standard-edition-52-coreswindows-server-2019-license-standard-edition-54-coreswindows-server-2019-license-standard-edition-56-coreswindows-server-2019-license-standard-edition-58-coreswindows-server-2019-license-standard-edition-60-coreswindows-server-2019-license-standard-edition-62-coreswindows-server-2019-license-standard-edition-64-coreswindows-server-2019-license-standard-edition-72-coreswindows-server-2019-license-standard-edition-8-coreswindows-server-2019-license-standard-edition-96-coreswindows-server-2022-license-datacenter-edition-10-coreswindows-server-2022-license-datacenter-edition-12-coreswindows-server-2022-license-datacenter-edition-128-coreswindows-server-2022-license-datacenter-edition-14-coreswindows-server-2022-license-datacenter-edition-16-coreswindows-server-2022-license-datacenter-edition-18-coreswindows-server-2022-license-datacenter-edition-192-coreswindows-server-2022-license-datacenter-edition-20-coreswindows-server-2022-license-datacenter-edition-22-coreswindows-server-2022-license-datacenter-edition-24-coreswindows-server-2022-license-datacenter-edition-256-coreswindows-server-2022-license-datacenter-edition-26-coreswindows-server-2022-license-datacenter-edition-28-coreswindows-server-2022-license-datacenter-edition-30-coreswindows-server-2022-license-datacenter-edition-32-coreswindows-server-2022-license-datacenter-edition-34-coreswindows-server-2022-license-datacenter-edition-36-coreswindows-server-2022-license-datacenter-edition-38-coreswindows-server-2022-license-datacenter-edition-40-coreswindows-server-2022-license-datacenter-edition-42-coreswindows-server-2022-license-datacenter-edition-44-coreswindows-server-2022-license-datacenter-edition-46-coreswindows-server-2022-license-datacenter-edition-48-coreswindows-server-2022-license-datacenter-edition-50-coreswindows-server-2022-license-datacenter-edition-512-coreswindows-server-2022-license-datacenter-edition-52-coreswindows-server-2022-license-datacenter-edition-54-coreswindows-server-2022-license-datacenter-edition-56-coreswindows-server-2022-license-datacenter-edition-58-coreswindows-server-2022-license-datacenter-edition-60-coreswindows-server-2022-license-datacenter-edition-62-coreswindows-server-2022-license-datacenter-edition-64-coreswindows-server-2022-license-datacenter-edition-72-coreswindows-server-2022-license-datacenter-edition-8-coreswindows-server-2022-license-datacenter-edition-96-coreswindows-server-2022-license-standard-edition-10-coreswindows-server-2022-license-standard-edition-12-coreswindows-server-2022-license-standard-edition-128-coreswindows-server-2022-license-standard-edition-14-coreswindows-server-2022-license-standard-edition-16-coreswindows-server-2022-license-standard-edition-18-coreswindows-server-2022-license-standard-edition-192-coreswindows-server-2022-license-standard-edition-20-coreswindows-server-2022-license-standard-edition-22-coreswindows-server-2022-license-standard-edition-24-coreswindows-server-2022-license-standard-edition-256-coreswindows-server-2022-license-standard-edition-26-coreswindows-server-2022-license-standard-edition-28-coreswindows-server-2022-license-standard-edition-30-coreswindows-server-2022-license-standard-edition-32-coreswindows-server-2022-license-standard-edition-34-coreswindows-server-2022-license-standard-edition-36-coreswindows-server-2022-license-standard-edition-38-coreswindows-server-2022-license-standard-edition-40-coreswindows-server-2022-license-standard-edition-42-coreswindows-server-2022-license-standard-edition-44-coreswindows-server-2022-license-standard-edition-46-coreswindows-server-2022-license-standard-edition-48-coreswindows-server-2022-license-standard-edition-50-coreswindows-server-2022-license-standard-edition-512-coreswindows-server-2022-license-standard-edition-52-coreswindows-server-2022-license-standard-edition-54-coreswindows-server-2022-license-standard-edition-56-coreswindows-server-2022-license-standard-edition-58-coreswindows-server-2022-license-standard-edition-60-coreswindows-server-2022-license-standard-edition-62-coreswindows-server-2022-license-standard-edition-64-coreswindows-server-2022-license-standard-edition-72-coreswindows-server-2022-license-standard-edition-8-coreswindows-server-2022-license-standard-edition-96-coreswindows-server-2025-license-datacenter-edition-10-coreswindows-server-2025-license-datacenter-edition-12-coreswindows-server-2025-license-datacenter-edition-128-coreswindows-server-2025-license-datacenter-edition-14-coreswindows-server-2025-license-datacenter-edition-16-coreswindows-server-2025-license-datacenter-edition-18-coreswindows-server-2025-license-datacenter-edition-192-coreswindows-server-2025-license-datacenter-edition-20-coreswindows-server-2025-license-datacenter-edition-22-coreswindows-server-2025-license-datacenter-edition-24-coreswindows-server-2025-license-datacenter-edition-256-coreswindows-server-2025-license-datacenter-edition-26-coreswindows-server-2025-license-datacenter-edition-28-coreswindows-server-2025-license-datacenter-edition-30-coreswindows-server-2025-license-datacenter-edition-32-coreswindows-server-2025-license-datacenter-edition-34-coreswindows-server-2025-license-datacenter-edition-36-coreswindows-server-2025-license-datacenter-edition-38-coreswindows-server-2025-license-datacenter-edition-40-coreswindows-server-2025-license-datacenter-edition-42-coreswindows-server-2025-license-datacenter-edition-44-coreswindows-server-2025-license-datacenter-edition-46-coreswindows-server-2025-license-datacenter-edition-48-coreswindows-server-2025-license-datacenter-edition-50-coreswindows-server-2025-license-datacenter-edition-512-coreswindows-server-2025-license-datacenter-edition-52-coreswindows-server-2025-license-datacenter-edition-54-coreswindows-server-2025-license-datacenter-edition-56-coreswindows-server-2025-license-datacenter-edition-58-coreswindows-server-2025-license-datacenter-edition-60-coreswindows-server-2025-license-datacenter-edition-62-coreswindows-server-2025-license-datacenter-edition-64-coreswindows-server-2025-license-datacenter-edition-72-coreswindows-server-2025-license-datacenter-edition-8-coreswindows-server-2025-license-datacenter-edition-96-coreswindows-server-2025-license-standard-edition-10-coreswindows-server-2025-license-standard-edition-12-coreswindows-server-2025-license-standard-edition-128-coreswindows-server-2025-license-standard-edition-14-coreswindows-server-2025-license-standard-edition-16-coreswindows-server-2025-license-standard-edition-18-coreswindows-server-2025-license-standard-edition-192-coreswindows-server-2025-license-standard-edition-20-coreswindows-server-2025-license-standard-edition-22-coreswindows-server-2025-license-standard-edition-24-coreswindows-server-2025-license-standard-edition-256-coreswindows-server-2025-license-standard-edition-26-coreswindows-server-2025-license-standard-edition-28-coreswindows-server-2025-license-standard-edition-30-coreswindows-server-2025-license-standard-edition-32-coreswindows-server-2025-license-standard-edition-34-coreswindows-server-2025-license-standard-edition-36-coreswindows-server-2025-license-standard-edition-38-coreswindows-server-2025-license-standard-edition-40-coreswindows-server-2025-license-standard-edition-42-coreswindows-server-2025-license-standard-edition-44-coreswindows-server-2025-license-standard-edition-46-coreswindows-server-2025-license-standard-edition-48-coreswindows-server-2025-license-standard-edition-50-coreswindows-server-2025-license-standard-edition-512-coreswindows-server-2025-license-standard-edition-52-coreswindows-server-2025-license-standard-edition-54-coreswindows-server-2025-license-standard-edition-56-coreswindows-server-2025-license-standard-edition-58-coreswindows-server-2025-license-standard-edition-60-coreswindows-server-2025-license-standard-edition-62-coreswindows-server-2025-license-standard-edition-64-coreswindows-server-2025-license-standard-edition-72-coreswindows-server-2025-license-standard-edition-8-coreswindows-server-2025-license-standard-edition-96-cores

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

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

List SPLA licensesProduction

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

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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Query parameters

status
SplaStatusEnum

Filter the value of status property (=)

ValuesterminatedusedwaitingToCheck
type
SplaTypeEnum

Filter the value of type property (=)

Valuesossqlstdsqlweb

Response

200integer[]successful operation

Example uses serviceName = string

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

Add an SPLA licenseProduction

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

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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

serialNumber
required
string

License serial number

type
required
SplaTypeEnum

License type

Valuesossqlstdsqlweb

Response

200integersuccessful operation

Example uses serviceName = string

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

Get an SPLA licenseProduction

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

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.

Path parameters

id
required
integer

License id

serviceName
required
string

The internal name of your dedicated server

Response

200splasuccessful operation
id
read-only
integer

License id

lastUpdate
read-only
stringdate-time

Last update timestamp

serialNumber
string

License serial number

status
read-only
SplaStatusEnum

Status of license

ValuesterminatedusedwaitingToCheck
type
read-only
SplaTypeEnum

License type

Valuesossqlstdsqlweb

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "id": 0,  "lastUpdate": "2024-01-01T12:00:00Z",  "serialNumber": "string",  "status": "terminated",  "type": "os"}

Update an SPLA licenseProduction

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

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

Path parameters

id
required
integer

License id

serviceName
required
string

The internal name of your dedicated server

Request body (required)

id
read-only
integer

License id

lastUpdate
read-only
stringdate-time

Last update timestamp

serialNumber
string

License serial number

status
read-only
SplaStatusEnum

Status of license

ValuesterminatedusedwaitingToCheck
type
read-only
SplaTypeEnum

License type

Valuesossqlstdsqlweb

Response

200—successful operation

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

Revoke an SPLA licenseProduction

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

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

Path parameters

id
required
integer

License id

serviceName
required
string

The internal name of your dedicated server

Response

200—successful operation

Example uses id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/spla/{id}/revoke \
  -H "authorization: Bearer $OVH_TOKEN"

List planned changesBeta

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

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.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200string[]successful operation

Example uses serviceName = string

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

Get a planned changeBeta

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

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

Path parameters

changeUuid
required
string

UUID of the change

serviceName
required
string

The internal name of your dedicated server

Response

200PlannedChangesuccessful operation
expectedEndDate
read-only
stringdate-time

Expected end date for this change

id
read-only
string

UUID of the change

status
read-only
PlannedChangeStatusEnum

Status of the change

Valuesacknowledgedassessauthorizecanceledcloseddoingdoneimplementnewreviewscheduledtodo
type
read-only
PlannedInterventionTypeEnum

Operation purpose

ValuesHARDWARE_UPGRADE_ON_ACTIVE_SERVER
wantedStartDate
read-only
stringdate-time

Wanted start date for this change

Example uses changeUuid = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/plannedChange/{changeUuid} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "expectedEndDate": "2024-01-01T12:00:00Z",  "id": "string",  "status": "acknowledged",  "type": "HARDWARE_UPGRADE_ON_ACTIVE_SERVER",  "wantedStartDate": "2024-01-01T12:00:00Z"}