Skip to main content

indies

Creates, updates, deletes, gets or lists an indies resource.

Overview​

Nameindies
TypeResource
Idovh.hosting_web.indies

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
attached_domainsarrayAttachedDomain IDs linked to this multidomain (wire: attachedDomains)
homestringHome directory
loginstringLogin of the multidomain independent user
statestringUser status (off, rw)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlogin, service_nameGet an independent user. Returns the home directory, state and attached domains of the independent multidomain user.
listselectservice_namelogin, x_pagination_modeList independent users. Returns the logins of the independent multidomain users of the hosting. Filter them by login.

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"}})
loginstringLogin of the multidomain independent user
service_namestringThe internal name of your hosting (wire: serviceName)
loginstringFilter the value of login property (like)
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 an independent user. Returns the home directory, state and attached domains of the independent multidomain user.

SELECT
attached_domains,
home,
login,
state
FROM ovh.hosting_web.indies
WHERE login = '{{ login }}' -- required
AND service_name = '{{ service_name }}' -- required
;