routing
Creates, updates, deletes, gets or lists a routing resource.
Overview
| Name | routing |
| Type | Resource |
| Id | cloudflare.email_routing.routing |
Fields
The following fields are returned by SELECT queries:
- list
Get Email Routing settings response
| Name | Datatype | Description |
|---|---|---|
errors | array | |
messages | array | |
result | object | |
success | boolean | Whether the API call was successful. (true) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | Get information about the settings for your Email Routing zone. | |
disable | exec | zone_id | Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work. | |
enable | exec | zone_id | Enable you Email Routing zone. Add and lock the necessary MX and SPF records. |
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 |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
Get information about the settings for your Email Routing zone.
SELECT
errors,
messages,
result,
success
FROM cloudflare.email_routing.routing
WHERE zone_id = '{{ zone_id }}' -- required
;
Lifecycle Methods
- disable
- enable
Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.
EXEC cloudflare.email_routing.routing.disable
@zone_id='{{ zone_id }}' --required
;
Enable you Email Routing zone. Add and lock the necessary MX and SPF records.
EXEC cloudflare.email_routing.routing.enable
@zone_id='{{ zone_id }}' --required
;