Skip to main content

task_accounts

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

Overview​

Nametask_accounts
TypeResource
Idovh.email_domain.task_accounts

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idintegerId of task
namestringAccount name of task
actionstringAction of task (addAccount, changeAccount, changePassword, deleteAccount, internalMigration, migration, temporaryTask, unknown)
datestring (date-time)Creation date of task
domainstringDomain name of task

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdomain, idGet an account task. Returns the action, the account name, the domain and the creation date of the email account task.
listselectdomainname, x_pagination_modeList account tasks. Returns the IDs of the pending email account tasks of the domain. Filter them by account name.

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"}})
domainstringName of your domain name
idintegerId of task
namestringAccount name
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 account task. Returns the action, the account name, the domain and the creation date of the email account task.

SELECT
id,
name,
action,
date,
domain
FROM ovh.email_domain.task_accounts
WHERE domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
;