Licenses
All operations require authentication.
List available servicesProduction
Query parameters
Filter resources on IAM tags
Response
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get the orderable CloudLinux versionsProduction
Query parameters
Your license Ip
Response
Possible values for license type
dedicateddedicatedClouddedicatedFailoverfailovervmvpsvps_cephvps_classicvps_cloudvps_cloud_2016vps_ssdReads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ orderableVersions \
-H "authorization: Bearer $OVH_TOKEN"[ { "orderableVersions": [ { "version": "SINGLE" } ], "serviceType": "dedicated" }]
Get this object propertiesProduction
Path parameters
The name of your CloudLinux license
Response
This license creation date
The internal name of your license
IAM resource metadata
The ip on which this license is attached
The license id on license provider side
This license state
okreleasedterminatedtoDeliverThis license version
SINGLEWITH_CPANELWITH_PLESK12cloudlinux-licenseExample uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName} \
-H "authorization: Bearer $OVH_TOKEN"{ "creation": "2024-01-01T12:00:00Z", "domain": "string", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "ip": "192.0.2.0", "licenseId": "string", "status": "ok", "version": "SINGLE"}
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 name of your CloudLinux license
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:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName}/ confirmTermination \
-H "authorization: Bearer $OVH_TOKEN""string"
Get service informationProduction
Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
Path parameters
The name of your CloudLinux license
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:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName}/ serviceInfos \
-H "authorization: Bearer $OVH_TOKEN"{ "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 name of your CloudLinux license
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:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName}/ serviceInfos \
-H "authorization: Bearer $OVH_TOKEN"Tasks linked to this licenseProduction
Path parameters
The name of your CloudLinux license
Query parameters
Filter the value of action property (=)
addWindowFromExistingSerialchangeIpchangeOsinstallLicenseoptionUpgradereleaseOptionversionUpgradeFilter the value of status property (=)
cancelleddoingdoneerrortodoResponse
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName}/ tasks \
-H "authorization: Bearer $OVH_TOKEN"[ 0]
Get this object propertiesProduction
Path parameters
The name of your CloudLinux license
This Task id
Response
This Task description
addWindowFromExistingSerialchangeIpchangeOsinstallLicenseoptionUpgradereleaseOptionversionUpgradeWhen was this Task done
The last time this Task was updated
This Task name
Current Taks status
cancelleddoingdoneerrortodoThis Task id
When was this Task created
Example uses serviceName = string, taskId = 0
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName}/ tasks/ {taskId} \
-H "authorization: Bearer $OVH_TOKEN"{ "action": "addWindowFromExistingSerial", "doneDate": "2024-01-01T12:00:00Z", "lastUpdate": "2024-01-01T12:00:00Z", "name": "string", "status": "cancelled", "taskId": 0, "todoDate": "2024-01-01T12:00:00Z"}
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 name of your CloudLinux license
Response
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cloudLinux/ {serviceName}/ terminate \
-H "authorization: Bearer $OVH_TOKEN""string"
List available servicesProduction
Query parameters
Filter resources on IAM tags
Response
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get the orderable CPanel versionsProduction
Query parameters
Your license Ip
Response
Possible values for license type
dedicateddedicatedClouddedicatedFailoverfailovervmvpsvps_cephvps_classicvps_cloudvps_cloud_2016vps_ssdReads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ orderableVersions \
-H "authorization: Bearer $OVH_TOKEN"[ { "orderableVersions": [ { "version": "VERSION_11_FOR_LINUX" } ], "serviceType": "dedicated" }]
Get this object propertiesProduction
Path parameters
The name of your Cpanel license
Response
This license creation date
Shall we delete this on expiration ?
The internal name of your license
IAM resource metadata
The ip on which this license is attached
The license id on license provider side
This license state
okreleasedterminatedtoDeliverThis license version
VERSION_11_FOR_LINUXVERSION_11_FOR_VIRTUOZZOVERSION_11_FOR_VPScpanel-license-version-11cpanel-license-version-11-for-virtuozzocpanel-license-version-11-for-vpsversion-admin-cloudversion-plus-cloudversion-premier-cloud-100version-premier-cloud-1000version-premier-cloud-10000version-premier-cloud-1100version-premier-cloud-1200version-premier-cloud-1300version-premier-cloud-1400version-premier-cloud-150version-premier-cloud-1500version-premier-cloud-1600version-premier-cloud-1700version-premier-cloud-1800version-premier-cloud-1900version-premier-cloud-200version-premier-cloud-2000version-premier-cloud-2100version-premier-cloud-2200version-premier-cloud-2300version-premier-cloud-2400version-premier-cloud-250version-premier-cloud-2500version-premier-cloud-2600version-premier-cloud-2700version-premier-cloud-2800version-premier-cloud-2900version-premier-cloud-300version-premier-cloud-3000version-premier-cloud-3100version-premier-cloud-3200version-premier-cloud-3300version-premier-cloud-3400version-premier-cloud-3500version-premier-cloud-3600version-premier-cloud-3700version-premier-cloud-3800version-premier-cloud-3900version-premier-cloud-400version-premier-cloud-4000version-premier-cloud-4100version-premier-cloud-4200version-premier-cloud-4300version-premier-cloud-4400version-premier-cloud-4500version-premier-cloud-4600version-premier-cloud-4700version-premier-cloud-4800version-premier-cloud-4900version-premier-cloud-500version-premier-cloud-5000version-premier-cloud-5100version-premier-cloud-5200version-premier-cloud-5300version-premier-cloud-5400version-premier-cloud-5500version-premier-cloud-5600version-premier-cloud-5700version-premier-cloud-5800version-premier-cloud-5900version-premier-cloud-600version-premier-cloud-6000version-premier-cloud-6100version-premier-cloud-6200version-premier-cloud-6300version-premier-cloud-6400version-premier-cloud-6500version-premier-cloud-6600version-premier-cloud-6700version-premier-cloud-6800version-premier-cloud-6900version-premier-cloud-700version-premier-cloud-7000version-premier-cloud-7100version-premier-cloud-7200version-premier-cloud-7300version-premier-cloud-7400version-premier-cloud-7500version-premier-cloud-7600version-premier-cloud-7700version-premier-cloud-7800version-premier-cloud-7900version-premier-cloud-800version-premier-cloud-8000version-premier-cloud-8100version-premier-cloud-8200version-premier-cloud-8300version-premier-cloud-8400version-premier-cloud-8500version-premier-cloud-8600version-premier-cloud-8700version-premier-cloud-8800version-premier-cloud-8900version-premier-cloud-900version-premier-cloud-9000version-premier-cloud-9100version-premier-cloud-9200version-premier-cloud-9300version-premier-cloud-9400version-premier-cloud-9500version-premier-cloud-9600version-premier-cloud-9700version-premier-cloud-9800version-premier-cloud-9900version-premier-metal-100version-premier-metal-1000version-premier-metal-10000version-premier-metal-1100version-premier-metal-1200version-premier-metal-1300version-premier-metal-1400version-premier-metal-150version-premier-metal-1500version-premier-metal-1600version-premier-metal-1700version-premier-metal-1800version-premier-metal-1900version-premier-metal-200version-premier-metal-2000version-premier-metal-2100version-premier-metal-2200version-premier-metal-2300version-premier-metal-2400version-premier-metal-250version-premier-metal-2500version-premier-metal-2600version-premier-metal-2700version-premier-metal-2800version-premier-metal-2900version-premier-metal-300version-premier-metal-3000version-premier-metal-3100version-premier-metal-3200version-premier-metal-3300version-premier-metal-3400version-premier-metal-3500version-premier-metal-3600version-premier-metal-3700version-premier-metal-3800version-premier-metal-3900version-premier-metal-400version-premier-metal-4000version-premier-metal-4100version-premier-metal-4200version-premier-metal-4300version-premier-metal-4400version-premier-metal-4500version-premier-metal-4600version-premier-metal-4700version-premier-metal-4800version-premier-metal-4900version-premier-metal-500version-premier-metal-5000version-premier-metal-5100version-premier-metal-5200version-premier-metal-5300version-premier-metal-5400version-premier-metal-5500version-premier-metal-5600version-premier-metal-5700version-premier-metal-5800version-premier-metal-5900version-premier-metal-600version-premier-metal-6000version-premier-metal-6100version-premier-metal-6200version-premier-metal-6300version-premier-metal-6400version-premier-metal-6500version-premier-metal-6600version-premier-metal-6700version-premier-metal-6800version-premier-metal-6900version-premier-metal-700version-premier-metal-7000version-premier-metal-7100version-premier-metal-7200version-premier-metal-7300version-premier-metal-7400version-premier-metal-7500version-premier-metal-7600version-premier-metal-7700version-premier-metal-7800version-premier-metal-7900version-premier-metal-800version-premier-metal-8000version-premier-metal-8100version-premier-metal-8200version-premier-metal-8300version-premier-metal-8400version-premier-metal-8500version-premier-metal-8600version-premier-metal-8700version-premier-metal-8800version-premier-metal-8900version-premier-metal-900version-premier-metal-9000version-premier-metal-9100version-premier-metal-9200version-premier-metal-9300version-premier-metal-9400version-premier-metal-9500version-premier-metal-9600version-premier-metal-9700version-premier-metal-9800version-premier-metal-9900version-pro-cloudversion-solo-cloudversion-solo-metalExample uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ {serviceName} \
-H "authorization: Bearer $OVH_TOKEN"{ "creation": "2024-01-01T12:00:00Z", "deleteAtExpiration": true, "domain": "string", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "ip": "192.0.2.0", "licenseId": "string", "status": "ok", "version": "VERSION_11_FOR_LINUX"}
Alter this object propertiesProduction
Path parameters
The name of your Cpanel license
Request body (required)
This license creation date
Shall we delete this on expiration ?
The internal name of your license
The ip on which this license is attached
The license id on license provider side
This license state
okreleasedterminatedtoDeliverThis license version
VERSION_11_FOR_LINUXVERSION_11_FOR_VIRTUOZZOVERSION_11_FOR_VPScpanel-license-version-11cpanel-license-version-11-for-virtuozzocpanel-license-version-11-for-vpsversion-admin-cloudversion-plus-cloudversion-premier-cloud-100version-premier-cloud-1000version-premier-cloud-10000version-premier-cloud-1100version-premier-cloud-1200version-premier-cloud-1300version-premier-cloud-1400version-premier-cloud-150version-premier-cloud-1500version-premier-cloud-1600version-premier-cloud-1700version-premier-cloud-1800version-premier-cloud-1900version-premier-cloud-200version-premier-cloud-2000version-premier-cloud-2100version-premier-cloud-2200version-premier-cloud-2300version-premier-cloud-2400version-premier-cloud-250version-premier-cloud-2500version-premier-cloud-2600version-premier-cloud-2700version-premier-cloud-2800version-premier-cloud-2900version-premier-cloud-300version-premier-cloud-3000version-premier-cloud-3100version-premier-cloud-3200version-premier-cloud-3300version-premier-cloud-3400version-premier-cloud-3500version-premier-cloud-3600version-premier-cloud-3700version-premier-cloud-3800version-premier-cloud-3900version-premier-cloud-400version-premier-cloud-4000version-premier-cloud-4100version-premier-cloud-4200version-premier-cloud-4300version-premier-cloud-4400version-premier-cloud-4500version-premier-cloud-4600version-premier-cloud-4700version-premier-cloud-4800version-premier-cloud-4900version-premier-cloud-500version-premier-cloud-5000version-premier-cloud-5100version-premier-cloud-5200version-premier-cloud-5300version-premier-cloud-5400version-premier-cloud-5500version-premier-cloud-5600version-premier-cloud-5700version-premier-cloud-5800version-premier-cloud-5900version-premier-cloud-600version-premier-cloud-6000version-premier-cloud-6100version-premier-cloud-6200version-premier-cloud-6300version-premier-cloud-6400version-premier-cloud-6500version-premier-cloud-6600version-premier-cloud-6700version-premier-cloud-6800version-premier-cloud-6900version-premier-cloud-700version-premier-cloud-7000version-premier-cloud-7100version-premier-cloud-7200version-premier-cloud-7300version-premier-cloud-7400version-premier-cloud-7500version-premier-cloud-7600version-premier-cloud-7700version-premier-cloud-7800version-premier-cloud-7900version-premier-cloud-800version-premier-cloud-8000version-premier-cloud-8100version-premier-cloud-8200version-premier-cloud-8300version-premier-cloud-8400version-premier-cloud-8500version-premier-cloud-8600version-premier-cloud-8700version-premier-cloud-8800version-premier-cloud-8900version-premier-cloud-900version-premier-cloud-9000version-premier-cloud-9100version-premier-cloud-9200version-premier-cloud-9300version-premier-cloud-9400version-premier-cloud-9500version-premier-cloud-9600version-premier-cloud-9700version-premier-cloud-9800version-premier-cloud-9900version-premier-metal-100version-premier-metal-1000version-premier-metal-10000version-premier-metal-1100version-premier-metal-1200version-premier-metal-1300version-premier-metal-1400version-premier-metal-150version-premier-metal-1500version-premier-metal-1600version-premier-metal-1700version-premier-metal-1800version-premier-metal-1900version-premier-metal-200version-premier-metal-2000version-premier-metal-2100version-premier-metal-2200version-premier-metal-2300version-premier-metal-2400version-premier-metal-250version-premier-metal-2500version-premier-metal-2600version-premier-metal-2700version-premier-metal-2800version-premier-metal-2900version-premier-metal-300version-premier-metal-3000version-premier-metal-3100version-premier-metal-3200version-premier-metal-3300version-premier-metal-3400version-premier-metal-3500version-premier-metal-3600version-premier-metal-3700version-premier-metal-3800version-premier-metal-3900version-premier-metal-400version-premier-metal-4000version-premier-metal-4100version-premier-metal-4200version-premier-metal-4300version-premier-metal-4400version-premier-metal-4500version-premier-metal-4600version-premier-metal-4700version-premier-metal-4800version-premier-metal-4900version-premier-metal-500version-premier-metal-5000version-premier-metal-5100version-premier-metal-5200version-premier-metal-5300version-premier-metal-5400version-premier-metal-5500version-premier-metal-5600version-premier-metal-5700version-premier-metal-5800version-premier-metal-5900version-premier-metal-600version-premier-metal-6000version-premier-metal-6100version-premier-metal-6200version-premier-metal-6300version-premier-metal-6400version-premier-metal-6500version-premier-metal-6600version-premier-metal-6700version-premier-metal-6800version-premier-metal-6900version-premier-metal-700version-premier-metal-7000version-premier-metal-7100version-premier-metal-7200version-premier-metal-7300version-premier-metal-7400version-premier-metal-7500version-premier-metal-7600version-premier-metal-7700version-premier-metal-7800version-premier-metal-7900version-premier-metal-800version-premier-metal-8000version-premier-metal-8100version-premier-metal-8200version-premier-metal-8300version-premier-metal-8400version-premier-metal-8500version-premier-metal-8600version-premier-metal-8700version-premier-metal-8800version-premier-metal-8900version-premier-metal-900version-premier-metal-9000version-premier-metal-9100version-premier-metal-9200version-premier-metal-9300version-premier-metal-9400version-premier-metal-9500version-premier-metal-9600version-premier-metal-9700version-premier-metal-9800version-premier-metal-9900version-pro-cloudversion-solo-cloudversion-solo-metalResponse
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ {serviceName} \
-H "authorization: Bearer $OVH_TOKEN"Returns an array of ips where the license can be moved toProduction
Path parameters
The name of your Cpanel license
Response
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ {serviceName}/ allowedDestinationIp \
-H "authorization: Bearer $OVH_TOKEN"[ "192.0.2.0/24"]
Will tell if the ip can accept the licenseProduction
Path parameters
The name of your Cpanel license
Query parameters
The Ip on which you want to move this license
Response
Messages from change IP
OKdestinationNotAllowedlicenseAlreadyExistsnotAllowedToHandleThisnotSameTypesameIpversionNotAllowedExample uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ {serviceName}/ canLicenseBeMovedTo \
-H "authorization: Bearer $OVH_TOKEN"{ "message": "OK", "success": true}
Move this license to another IpProduction
Path parameters
The name of your Cpanel license
Request body (required)
The Ip on which you want to move this license
Response
This Task description
addWindowFromExistingSerialchangeIpchangeOsinstallLicenseoptionUpgradereleaseOptionversionUpgradeWhen was this Task done
The last time this Task was updated
This Task name
Current Taks status
cancelleddoingdoneerrortodoThis Task id
When was this Task created
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ {serviceName}/ changeIp \
-H "authorization: Bearer $OVH_TOKEN"{ "action": "addWindowFromExistingSerial", "doneDate": "2024-01-01T12:00:00Z", "lastUpdate": "2024-01-01T12:00:00Z", "name": "string", "status": "cancelled", "taskId": 0, "todoDate": "2024-01-01T12:00:00Z"}
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 name of your Cpanel license
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:/ / api.eu.ovhcloud.com/ 1.0/ license/ cpanel/ {serviceName}/ confirmTermination \
-H "authorization: Bearer $OVH_TOKEN""string"
Get service informationProduction
Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
Path parameters
The name of your Cpanel license
Response
Indicates that the service can be set up to be deleted at expiration