configurations_obfuscated_emails

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

Overview

Name	configurations_obfuscated_emails
Type	Resource
Id	ovh.domain.configurations_obfuscated_emails

Fields

The following fields are returned by SELECT queries:

list

Configuration of the email obfuscations for contacts related to a domain name

Name	Datatype	Description
status	string	Status of the email obfuscation (done, todo)
type	string	Type of the contact whose email is obfuscated by this configuration (admin, all, billing, owner, tech)
value	string	Obfuscated email address

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name		Retrieve obfuscated emails configuration
update	update	service_name, contacts		Save a new obfuscated emails configuration
refresh	exec	serviceName, contacts		Refresh an obfuscated emails configuration with new values

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"}})
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

list

Retrieve obfuscated emails configuration

SELECT
status,
type,
value
FROM ovh.domain.configurations_obfuscated_emails
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Save a new obfuscated emails configuration

UPDATE ovh.domain.configurations_obfuscated_emails
SET 
contacts = '{{ contacts }}'
WHERE 
service_name = '{{ service_name }}' --required
AND contacts = '{{ contacts }}' --required
RETURNING
status,
type,
value;

Lifecycle Methods

EXEC variables use wire (API) names.

refresh

Refresh an obfuscated emails configuration with new values

EXEC ovh.domain.configurations_obfuscated_emails.refresh 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contacts": "{{ contacts }}"
}'
;