Skip to main content

license_cpanel_upgrades

Creates, updates, deletes, gets or lists a license_cpanel_upgrades resource.

Overview​

Namelicense_cpanel_upgrades
TypeResource
Idovh.order.license_cpanel_upgrades

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
order_idintegerIdentifier of the order (wire: orderId)
contractsarrayList of contracts related to the order
detailsarrayDetails of the order
pricesobjectPrices of the order including with and without taxes
urlstringURL to download the order

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectduration, service_name, versionGet prices and contracts information
listselectservice_name, versionx_pagination_modeGet allowed durations for 'upgrade' option
createinsertduration, service_name, versionCreate order

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
durationstringDuration
service_namestringThe name of your Cpanel license (wire: serviceName)
versionstringWanted new version
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.license_cpanel_upgrades
WHERE duration = '{{ duration }}' -- required
AND service_name = '{{ service_name }}' -- required
AND version = '{{ version }}' -- required
;

INSERT examples​

Create order

INSERT INTO ovh.order.license_cpanel_upgrades (
version,
duration,
service_name
)
SELECT 
'{{ version }}' /* required */,
'{{ duration }}',
'{{ service_name }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;
Last updated on