Server
All operations require authentication.
List dedicated server resourcesBeta
Get the list of all my dedicated server resources.
Query parameters
Filter resources on IAM tags
Response
Checksum of the target spec (mutable params). Send it back on update. Rejected if another caller changed the target since your read.
State observed on the server
Asynchronous operations currently running. Omitted, never null, when no update is running, and always omitted from the server list.
IAM resource metadata
Service name of the dedicated server resource
Reflects the readiness of the dedicated server resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification last declared on the server
Reads your token from $OVH_TOKEN
$ curl https:/[ { "checksum": "string", "currentState": { "actions": [ { "action": "ENABLE_ENCRYPTION_AT_REST", "blockedBy": [ { "code": null, "details": null, "nature": null } ], "status": "AVAILABLE" } ], "features": { "encryptionAtRest": { "enabled": true } } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "features": { "encryptionAtRest": { "enabled": true } } } }]
Get dedicated server resourceBeta
Get the details of the dedicated server resource.
Path parameters
Service name
Query parameters
Also report, under currentState.actions, whether the server accepts each action it can be asked to perform
Response
Checksum of the target spec (mutable params). Send it back on update. Rejected if another caller changed the target since your read.
State observed on the server
Asynchronous operations currently running. Omitted, never null, when no update is running, and always omitted from the server list.
IAM resource metadata
Service name of the dedicated server resource
Reflects the readiness of the dedicated server resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGTarget specification last declared on the server
Example uses serviceName = string
$ curl https:/{ "checksum": "string", "currentState": { "actions": [ { "action": "ENABLE_ENCRYPTION_AT_REST", "blockedBy": [ { "code": "EXCLUSIVE_OPERATION_RUNNING", "details": { "key": null }, "nature": "PERMANENT" } ], "status": "AVAILABLE" } ], "features": { "encryptionAtRest": { "enabled": true } } }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "features": { "encryptionAtRest": { "enabled": true } } }}
Update a serverProduction
Update a server. Updates the writable properties of the server, such as its boot, rescue, monitoring and datacenter intervention settings. The other properties are read-only.
Path parameters
The internal name of your dedicated server
Request body (required)
dedicated AZ localisation
Ipxe script served on boot
dedicater server commercial range
dedicated datacenter localisation
bhs1bhs2bhs3bhs4bhs5bhs6bhs7bhs8cch01crx1crx2dc1eri1eri2frcrx41frcrx42frcrx43gra04gra1gra2gra3gswhdf01hil1ieb01itbsi01itmil01itzvf01lil1-int1lim1lim2lim3mr901p19rbxrbx-hzrbx1rbx10rbx2rbx3rbx4rbx5rbx6rbx7rbx8rbx9sbg1sbg2sbg3sbg4sbg5sgp02sgp1syd03syd1syd2vin1waw1ynm1yyz01EfiBootloader path
dedicated server ip
Icmp monitoring state
dedicated server name
Prevent datacenter intervention
Operating system
Power state of the server
poweroffpoweronDoes this server have professional use option
dedicated region localisation
Custom email used to receive rescue credentials
Public SSH Key used in the rescue mode
dedicated server reverse
your server id
All states a Dedicated can in
errorhackedhackedBlockedokDedicated server support level
criticalfastpathgsproResponse
Example uses serviceName = string
$ curl https:/Get service informationProduction
Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
Path parameters
The internal name of your dedicated server
Response
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidExample uses serviceName = string
$ curl https:/{ "canDeleteAtExpiration": true, "contactAdmin": "string", "contactBilling": "string", "contactTech": "string", "creation": "2024-01-01", "domain": "string", "engagedUpTo": "2024-01-01", "expiration": "2024-01-01", "possibleRenewPeriod": [ 0 ], "renew": { "automatic": true, "deleteAtExpiration": true, "forced": true, "manualPayment": true, "period": 0 }, "renewalType": "automaticForcedProduct", "serviceId": 0, "status": "autorenewInProgress"}
Update service informationProduction
Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.
Path parameters
The internal name of your dedicated server
Request body (required)
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidResponse
Example uses serviceName = string
$ curl https:/Get the hardware specificationsProduction
Get the hardware specifications. Returns the hardware of the server: commercial name, processors, memory, disk groups, expansion cards, motherboard, form factor and default RAID settings.
Path parameters
The internal name of your dedicated server
Response
Server boot mode
legacyuefiuefi-legacynumber of cores per processor
Default disk group id used for OS reinstallation when not specified
Default hardware raid size for this server
Default hardware raid type configured on this server
raid0raid1raid10raid1Eraid5raid50raid6raid60commercial name of this server
details about the groups of disks in the server
details about the server's expansion cards
Server form factor
0.25u0.5u1u2u3u4uram capacity
server motherboard
number of processors in this dedicated server
processor architecture bit
arm64armhf32ppc64x86x86-htx86_64processor name
number of threads per processor
Capacity of the USB keys installed on your server, if any
Example uses serviceName = string
$ curl https:/{ "bootMode": "legacy", "coresPerProcessor": 0, "defaultDiskGroupId": 0, "defaultHardwareRaidSize": { "unit": "string", "value": 0 }, "defaultHardwareRaidType": "raid0", "description": "string", "diskGroups": [ { "defaultHardwareRaidSize": { "unit": "string", "value": 0 }, "defaultHardwareRaidType": "raid0", "description": "string", "diskGroupId": 0, "diskSize": { "unit": "string", "value": 0 }, "diskType": "string", "numberOfDisks": 0, "raidController": "string" } ], "expansionCards": [ { "description": "string", "type": "fpga" } ], "formFactor": "0.25u", "memorySize": { "unit": "string", "value": 0 }, "motherboard": "string", "numberOfProcessors": 0, "processorArchitecture": "arm64", "processorName": "string", "threadsPerProcessor": 0, "usbKeys": [ { "unit": "string", "value": 0 } ]}
Get the IP capabilitiesProduction
Get the IP capabilities. Returns the IPv4 and IPv6 addresses that can be ordered for the server. For each IP type, it gives the orderable block sizes, how many IPs and prefixes can be routed to the server, and whether they are included in the offer.
Path parameters
The internal name of your dedicated server
Response
Orderable IP v4 details
Orderable IP v6 details
Example uses serviceName = string
$ curl https:/{ "ipv4": [ { "blockSizes": [ 1 ], "included": true, "ipNumber": 0, "number": 0, "optionRequired": "professionalUse", "type": "failover" } ], "ipv6": [ { "blockSizes": [ 1 ], "included": true, "ipNumber": 0, "number": 0, "optionRequired": "professionalUse", "type": "failover" } ]}
Get the network specificationsProduction
Get the network specifications. Returns the network specifications of the server: connection rate, bandwidth, vRack bandwidth, traffic, OLA, routing, switching and virtual MAC details.
Path parameters
The internal name of your dedicated server
Response
Bandwidth details
Network connection flow rate
OLA details
Routing details
Switching details
Traffic details
A structure describing VMAC Infos for this dedicated server
vRack details
Example uses serviceName = string
$ curl https:/{ "bandwidth": { "InternetToOvh": { "unit": "string", "value": 0 }, "OvhToInternet": { "unit": "string", "value": 0 }, "OvhToOvh": { "unit": "string", "value": 0 }, "type": "improved" }, "connection": { "unit": "string", "value": 0 }, "ola": { "available": true, "availableModes": [ { "default": true, "interfaces": [ { "aggregation": true, "count": 0, "type": "public" } ], "name": "string" } ], "supportedModes": [ "public" ] }, "routing": { "ipv4": { "gateway": "192.0.2.0", "ip": "192.0.2.0", "network": "192.0.2.0/24" }, "ipv6": { "gateway": "2001:41d0:1:1994::1", "ip": "2001:41d0::/128", "network": "2001:41d0::/128" } }, "switching": { "name": "string" }, "traffic": { "inputQuotaSize": { "unit": "string", "value": 0 }, "inputQuotaUsed": { "unit": "string", "value": 0 }, "isThrottled": true, "outputQuotaSize": { "unit": "string", "value": 0 }, "outputQuotaUsed": { "unit": "string", "value": 0 }, "resetQuotaDate": "string" }, "vmac": { "quota": 0, "supported": true }, "vrack": { "bandwidth": { "unit": "string", "value": 0 }, "type": "included" }}
List optionsProduction
List options. Returns the names of the options of the server. Get an option to know whether it is subscribed or released.
Path parameters
The internal name of your dedicated server
Response
Example uses serviceName = string
$ curl https:/[ "BACKUPPROTOCOL"]
Get an optionProduction
Get an option. Returns the state of an option of the server, subscribed or released. The option is identified by its name, such as BANDWIDTH, OLA or SGX.
Path parameters
The option name
BACKUPPROTOCOLBANDWIDTHBANDWIDTH_VRACKOLASGXTRAFFICTRAFFIC_DISCOVERTUNINGTUNING_FIREWALLTUNING_KVMUSB_KVM_IPThe internal name of your dedicated server
Response
The option name
BACKUPPROTOCOLBANDWIDTHBANDWIDTH_VRACKOLASGXTRAFFICTRAFFIC_DISCOVERTUNINGTUNING_FIREWALLTUNING_KVMUSB_KVM_IPThe state of the option
releasedsubscribedExample uses option = BACKUPPROTOCOL, serviceName = string
$ curl https:/{ "option": "BACKUPPROTOCOL", "state": "released"}
Release an optionProduction
Release an option. Releases an option of the server, identified by its name, such as BANDWIDTH, TRAFFIC or USB_KVM_IP. The name is one of the options a server can have and release.
Path parameters
The option name
BACKUPPROTOCOLBANDWIDTHBANDWIDTH_VRACKOLASGXTRAFFICTRAFFIC_DISCOVERTUNINGTUNING_FIREWALLTUNING_KVMUSB_KVM_IPThe internal name of your dedicated server
Response
Example uses option = BACKUPPROTOCOL, serviceName = string
$ curl https:/List tasksProduction
List tasks. Returns the IDs of the tasks of the server, such as reboots, reinstallations and IP moves. Filter them by function or status.
Path parameters
The internal name of your dedicated server
Query parameters
Filter the value of function property (=)
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeleteFilter the value of status property (=)
cancelledcustomerErrordoingdoneinitovhErrortodoResponse
Example uses serviceName = string
$ curl https:/[ 0]
Get a taskProduction
Get a task. Returns the function, status and dates of a task of the server. needSchedule tells whether the task must be scheduled, and plannedInterventionId links it to a planned intervention.
Path parameters
The internal name of your dedicated server
the id of the task
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
Reference of the thread on the support tool
Example uses serviceName = string, taskId = 0
$ curl https:/{ "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 available time slotsBeta
List available time slots. Returns the time slots available for the planned intervention of a task, between periodStart and periodEnd. Only a task whose needSchedule is true has slots; any other task returns an error.
Path parameters
The internal name of your dedicated server
the id of the task
Query parameters
End of the period to query
Begining of the period to query
Response
End date for the planned intervention
Start date for the planned intervention
Example uses serviceName = string, taskId = 0
$ curl https:/[ { "endDate": "2024-01-01T12:00:00Z", "startDate": "2024-01-01T12:00:00Z" }]
Cancel a taskProduction
Cancel a task. Stops the progression of a task of the server, if possible. Not every task can be canceled: a task that is already done returns an error.
Path parameters
The internal name of your dedicated server
the id of the task
Response
Example uses serviceName = string, taskId = 0
$ curl https:/Schedule an interventionBeta
Schedule an intervention. Schedules the intervention linked to a task at the wanted start date. The body must also state whether a backup of the data has been made. A task whose needSchedule is false cannot be scheduled.
Path parameters
The internal name of your dedicated server
the id of the task
Request body (required)
Whether or not you have made a backup of your data
Wanted begining date for your intervention
Response
Example uses serviceName = string, taskId = 0
$ curl https:/List ongoing tasksBeta
List ongoing tasks. Returns what is in progress on the server. Each entry gives a short description, the datacenter of the server and the processing date.
Path parameters
The internal name of your dedicated server
Response
Location of the server
bhs1bhs2bhs3bhs4bhs5bhs6bhs7bhs8cch01crx1crx2dc1eri1eri2frcrx41frcrx42frcrx43gra04gra1gra2gra3gswhdf01hil1ieb01itbsi01itmil01itzvf01lil1-int1lim1lim2lim3mr901p19rbxrbx-hzrbx1rbx10rbx2rbx3rbx4rbx5rbx6rbx7rbx8rbx9sbg1sbg2sbg3sbg4sbg5sgp02sgp1syd03syd1syd2vin1waw1ynm1yyz01Short text describing the entry
Name of the dedicated server
Timestamp for processing
Example uses serviceName = string
$ curl https:/[ { "datacenter": "bhs1", "description": "string", "server": "string", "todoDate": "2024-01-01T12:00:00Z" }]
Request a cooling module replacementBeta
Request a cooling module replacement. Opens a support request to replace a cooling module of the server, with a comment and technical details or logs. Returns the identifiers of the created support ticket and message.
Path parameters
The internal name of your dedicated server
Request body (required)
User comment
Technical details or logs
Response
Notice or warning
Message identifier
Ticket identifier
Ticket external number
Example uses serviceName = string
$ curl https:/{ "additionalNotice": "string", "messageId": 0, "ticketId": 0, "ticketNumber": 0}
Request a disk replacementBeta
Request a disk replacement. Opens a support request to replace disks of the server, identified by serial number or slot. With inverse set to true, the listed disks are kept and all the other disks are replaced. Returns the identifiers of the created support ticket and message.
Path parameters
The internal name of your dedicated server
Request body (required)
User comment
If 'inverse' is set as 'false', the list of HDD TO REPLACE. If 'inverse' is set as 'true', the list of HDD TO NOT REPLACE.
If set to 'true', replace only NON LISTED DISKS
Response
Notice or warning
Message identifier
Ticket identifier
Ticket external number
Example uses serviceName = string
$ curl https:/{ "additionalNotice": "string", "messageId": 0, "ticketId": 0, "ticketNumber": 0}
Request a memory module replacementBeta
Request a memory module replacement. Opens a support request to replace a faulty RAM module of the server, with a comment and technical details or logs. The faulty slots can be listed if known. Returns the identifiers of the created support ticket and message.
Path parameters
The internal name of your dedicated server
Request body (required)
User comment
Technical details or logs
The list of faulty RAM slots (if you have the information)
Response
Notice or warning
Message identifier
Ticket identifier
Ticket external number
Example uses serviceName = string
$ curl https:/{ "additionalNotice": "string", "messageId": 0, "ticketId": 0, "ticketNumber": 0}
Get access credentialsProduction
Get access credentials. Returns the credentials to connect to the server or to an application installed on it, such as SSH, RDP, SQL Server or a web control panel. Each entry gives the access type, URL, login and password.
Path parameters
The internal name of your dedicated server
Response
Password
Application access type
DIRECTADMIN_PANELPLESK_PANELPROXMOX_PANELRDPSQL_SERVERSSHWEB_PANELUrl
Login
Example uses serviceName = string
$ curl https:/[ { "password": "string", "type": "DIRECTADMIN_PANEL", "url": "string", "user": "string" }]
Change service contactsProduction
Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
Path parameters
The internal name of your dedicated server
Request body (required)
The contact to set as admin contact
The contact to set as billing contact
The contact to set as tech contact
Response
Example uses serviceName = string
$ curl https:/[ 0]
Request service terminationProduction
Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.
Path parameters
The internal name of your dedicated server
Response
Example uses serviceName = string
$ curl https:/"string"
Confirm service terminationProduction
Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.
Path parameters
The internal name of your dedicated server
Request body (required)
Commentary about your termination request
What next after your termination request
NOT_REPLACING_SERVICEOTHERSUBSCRIBE_AN_OTHER_SERVICESUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITORSUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITORReason of your termination request
FEATURES_DONT_SUIT_MELACK_OF_PERFORMANCESMIGRATED_TO_ANOTHER_OVH_PRODUCTMIGRATED_TO_COMPETITORNOT_ENOUGH_RECOGNITIONNOT_NEEDED_ANYMORENOT_RELIABLENO_ANSWEROTHERPRODUCT_DIMENSION_DONT_SUIT_MEPRODUCT_TOOLS_DONT_SUIT_METOO_EXPENSIVETOO_HARD_TO_USEUNSATIFIED_BY_CUSTOMER_SUPPORTThe termination token sent by email to the admin contact
Response
Example uses serviceName = string
$ curl https:/"string"