Skip to main content

deposit_details

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

Overview​

Namedeposit_details
TypeResource
Idovh.me.deposit_details

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
deposit_detail_idstring (wire: depositDetailId)
descriptionstring
domainstring
quantitystring
total_priceobjectPrice with its currency and textual representation (wire: totalPrice)
unit_priceobjectPrice with its currency and textual representation (wire: unitPrice)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdeposit_detail_id, deposit_idGet this object properties
listselectdeposit_idx_pagination_modeGive access to all entries of this deposit

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"}})
deposit_detail_idstring (wire: depositDetailId)
deposit_idstring (wire: depositId)
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 this object properties

SELECT
deposit_detail_id,
description,
domain,
quantity,
total_price,
unit_price
FROM ovh.me.deposit_details
WHERE deposit_detail_id = '{{ deposit_detail_id }}' -- required
AND deposit_id = '{{ deposit_id }}' -- required
;