local_seo_accounts

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

Overview

Name	local_seo_accounts
Type	Resource
Id	ovh.hosting_web.local_seo_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Account id
task_id	integer	Running task associated to the account (wire: taskId)
creation_date	string (date-time)	Date of creation of the account (wire: creationDate)
email	string	Email address associated to the account
last_update	string (date-time)	Date of the last account's update (wire: lastUpdate)
status	string	Current status of the account (created, creating, deleting, updating)

list

Local SEO accounts

Name	Datatype	Description
id	integer	Account id
task_id	integer	Running task associated to the account (wire: taskId)
creation_date	string (date-time)	Date of creation of the account (wire: creationDate)
email	string	Email address associated to the account
last_update	string (date-time)	Date of the last account's update (wire: lastUpdate)
status	string	Current status of the account (created, creating, deleting, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get a local SEO account. Returns the email address, status, creation date and last update date of the local SEO account, and its running task.
list	select	service_name	email, x_pagination_mode	List local SEO accounts. Returns the IDs of the local SEO accounts of the hosting. Filter them by email.
login	exec	id, serviceName		Log in to a local SEO account. Returns a single sign-on URL, with an authentication token, to log in to the local SEO account.

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"}})
id	integer	Account id
serviceName	string	The internal name of your hosting
service_name	string	The internal name of your hosting (wire: serviceName)
email	string	Filter the value of email property (like)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a local SEO account. Returns the email address, status, creation date and last update date of the local SEO account, and its running task.

SELECT
id,
task_id,
creation_date,
email,
last_update,
status
FROM ovh.hosting_web.local_seo_accounts
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List local SEO accounts. Returns the IDs of the local SEO accounts of the hosting. Filter them by email.

SELECT
id,
task_id,
creation_date,
email,
last_update,
status
FROM ovh.hosting_web.local_seo_accounts
WHERE service_name = '{{ service_name }}' -- required
AND email = '{{ email }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

login

Log in to a local SEO account. Returns a single sign-on URL, with an authentication token, to log in to the local SEO account.

EXEC ovh.hosting_web.local_seo_accounts.login 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;