local_seo_email_availabilities

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

Overview

Name	local_seo_email_availabilities
Type	Resource
Id	ovh.hosting_web.local_seo_email_availabilities

Fields

The following fields are returned by SELECT queries:

get_by_service_name

successful operation

Name	Datatype	Description
service_name	string	Hosting on which the email address is used (wire: serviceName)
availability	string	Availability of the email address (available, merge, nic, taken)

get

successful operation

Name	Datatype	Description
service_name	string	Hosting on which the email address is used (wire: serviceName)
availability	string	Availability of the email address (available, merge, nic, taken)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_service_name	select	email, service_name		Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it.
get	select	email		Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it.

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.

Name	Datatype	Description
api_host	string	The 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"}})
email	string	The email address to check
service_name	string	The internal name of your hosting (wire: serviceName)

SELECT examples

get_by_service_name

Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it.

SELECT
service_name,
availability
FROM ovh.hosting_web.local_seo_email_availabilities
WHERE email = '{{ email }}' -- required
AND service_name = '{{ service_name }}' -- required
;

get

Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it.

SELECT
service_name,
availability
FROM ovh.hosting_web.local_seo_email_availabilities
WHERE email = '{{ email }}' -- required
;