dkims
Creates, updates, deletes, gets or lists a dkims resource.
Overview​
| Name | dkims |
| Type | Resource |
| Id | ovh.email_domain.dkims |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
active_selector | string | activeSelector (wire: activeSelector) |
autoconfig | boolean | If true your DNS CNAME configuration is valid |
selectors | array | DKIM status |
status | string | DKIM status (disabled, enabled, error, modifying, toConfigure) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain | Get the DKIM configuration. Returns the DKIM status, the active selector, the selectors with their CNAME records, and whether the DNS CNAME configuration is valid. | |
disable | exec | domain | Disable DKIM. Stops signing the emails sent from the domain with DKIM, and returns the task. Read the result with GET dkim. | |
enable | exec | domain | Enable DKIM. Starts signing the emails sent from the domain with DKIM, and returns the task. Read the result with GET dkim. |
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"}}) |
domain | string | Name of your domain name |
SELECT examples​
- get
Get the DKIM configuration. Returns the DKIM status, the active selector, the selectors with their CNAME records, and whether the DNS CNAME configuration is valid.
SELECT
active_selector,
autoconfig,
selectors,
status
FROM ovh.email_domain.dkims
WHERE domain = '{{ domain }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- disable
- enable
Disable DKIM. Stops signing the emails sent from the domain with DKIM, and returns the task. Read the result with GET dkim.
EXEC ovh.email_domain.dkims.disable
@domain='{{ domain }}' --required
;
Enable DKIM. Starts signing the emails sent from the domain with DKIM, and returns the task. Read the result with GET dkim.
EXEC ovh.email_domain.dkims.enable
@domain='{{ domain }}' --required
;