List account or zone routing rules
email_routing.rules.list(RuleListParams**kwargs) -> SyncV4PagePaginationArray[AccountRule]
GET/{accounts_or_zones}/{account_or_zone_id}/email/routing/rules
Lists existing routing rules across all zones in the account or zone.
Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
List account or zone routing rules
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted
api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted
)
page = client.email_routing.rules.list(
account_id="account_id",
)
page = page.result[0]
print(page.id){
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "a7e6fb77503c41d8a7f3113c6918f10c",
"actions": [
{
"type": "forward",
"value": [
"destinationaddress@example.net"
]
}
],
"enabled": true,
"matchers": [
{
"type": "literal",
"field": "to",
"value": "test@example.com"
}
],
"name": "Send to user@example.net rule.",
"priority": 0,
"source": "api",
"tag": "a7e6fb77503c41d8a7f3113c6918f10c",
"zone": {
"name": "example.com",
"tag": "023e105f4ecef8ad9ca31a8372d0c353"
}
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 1,
"total_pages": 100
}
}Returns Examples
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "a7e6fb77503c41d8a7f3113c6918f10c",
"actions": [
{
"type": "forward",
"value": [
"destinationaddress@example.net"
]
}
],
"enabled": true,
"matchers": [
{
"type": "literal",
"field": "to",
"value": "test@example.com"
}
],
"name": "Send to user@example.net rule.",
"priority": 0,
"source": "api",
"tag": "a7e6fb77503c41d8a7f3113c6918f10c",
"zone": {
"name": "example.com",
"tag": "023e105f4ecef8ad9ca31a8372d0c353"
}
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 1,
"total_pages": 100
}
}