configurations_optins
Creates, updates, deletes, gets or lists a configurations_optins resource.
Overview​
| Name | configurations_optins |
| Type | Resource |
| Id | ovh.domain.configurations_optins |
Fields​
The following fields are returned by SELECT queries:
- list
Configuration of the optin fields for contacts related to a domain name
| Name | Datatype | Description |
|---|---|---|
fields | array | Fields to display publicly on the Whois |
type | string | Type of the contact associated to the optin configuration (admin, all, billing, owner, tech) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | service_name | Retrieve optin configuration | |
update | update | service_name | Save a new optin configuration |
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"}}) |
service_name | string | Service name (wire: serviceName) |
SELECT examples​
- list
Retrieve optin configuration
SELECT
fields,
type
FROM ovh.domain.configurations_optins
WHERE service_name = '{{ service_name }}' -- required
;
UPDATE examples​
- update
Save a new optin configuration
UPDATE ovh.domain.configurations_optins
SET
optin = '{{ optin }}'
WHERE
service_name = '{{ service_name }}' --required
RETURNING
fields,
type;