Skip to main content

task_redirections

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

Overview​

Nametask_redirections
TypeResource
Idovh.email_domain.task_redirections

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idstringId of task
accountstringAccount name of task
actionstringAction of task (add, change, delete)
datestring (date-time)Creation date of task
domainstringDomain name of task
typestringType of action filter (25g, alias, delete, filter, forward, responder)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdomain, idReturns the account, type, action and creation date of the task. (Alpha version)
listselectdomainaccount, x_pagination_modeReturns the IDs of the pending redirection tasks of the domain. Filter them by account. (Alpha version)

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
idstringId
accountstringAccount 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​

Returns the account, type, action and creation date of the task. (Alpha version)

SELECT
id,
account,
action,
date,
domain,
type
FROM ovh.email_domain.task_redirections
WHERE domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
;