Skip to main content

account_migrates

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

Overview​

Nameaccount_migrates
TypeResource
Idovh.email_domain.account_migrates

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
destination_service_namestringService name allowed as migration destination (wire: destinationServiceName)
contact_adminstringAdmin contact of service (wire: contactAdmin)
contact_billingstringBilling contact of service (wire: contactBilling)
contact_techstringTech contact of service (wire: contactTech)
creationstring (date)Creation date of service
expirationstring (date)Expiration date of service
typestringOffer type of service (EMAIL PRO, HOSTED EXCHANGE, PRIVATE EXCHANGE, PROVIDER EXCHANGE)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectaccount_name, destination_service_name, domainGet a migration destination. Returns the offer type, creation and expiration dates, and admin, tech and billing contacts of the destination service. (Beta version)
listselectaccount_name, domaintype, x_pagination_modeList migration destinations. Returns the names of the services the email account can be migrated to. Filter them by type: Email Pro, hosted, private or provider Exchange. (Beta 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
account_namestringName of account (wire: accountName)
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"}})
destination_service_namestringService name allowed as migration destination (wire: destinationServiceName)
domainstringName of your domain name
typestringType of migration service
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 a migration destination. Returns the offer type, creation and expiration dates, and admin, tech and billing contacts of the destination service. (Beta version)

SELECT
destination_service_name,
contact_admin,
contact_billing,
contact_tech,
creation,
expiration,
type
FROM ovh.email_domain.account_migrates
WHERE account_name = '{{ account_name }}' -- required
AND destination_service_name = '{{ destination_service_name }}' -- required
AND domain = '{{ domain }}' -- required
;