Zero TrustZero Trust Gateway Rules

List Zero Trust Gateway rules

GET
Fetches the Zero Trust Gateway rules for an account.

Path parameters

identifierstringRequired

Response

This endpoint returns an object
result
list of objectsOptional
GET
1curl https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/rules \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "result": [
3 {
4 "action": "on",
5 "created_at": "2014-01-01T05:20:00.12345Z",
6 "description": "Block bad websites based on their host name.",
7 "device_posture": "any(device_posture.checks.passed[*] in {\"1308749e-fcfb-4ebc-b051-fe022b632644\"})",
8 "enabled": true,
9 "filters": [
10 "http"
11 ],
12 "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
13 "identity": "any(identity.groups.name[*] in {\"finance\"})",
14 "name": "block bad websites",
15 "rule_settings": {
16 "allow_child_bypass": false,
17 "audit_ssh": {
18 "command_logging": false
19 },
20 "biso_admin_controls": {
21 "dcp": false,
22 "dd": false,
23 "dk": false,
24 "dp": false,
25 "du": false
26 },
27 "block_page_enabled": true,
28 "block_reason": "This website is a security risk",
29 "bypass_parent_rule": false,
30 "check_session": {
31 "duration": "300s",
32 "enforce": true
33 },
34 "dns_resolvers": {
35 "ipv4": [
36 {
37 "ip": "2001:DB8::/64",
38 "port": 1,
39 "route_through_private_network": true,
40 "vnet_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
41 }
42 ],
43 "ipv6": [
44 {
45 "ip": "2001:DB8::/64",
46 "port": 1,
47 "route_through_private_network": true,
48 "vnet_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
49 }
50 ]
51 },
52 "egress": {
53 "ipv4": "192.0.2.2",
54 "ipv4_fallback": "192.0.2.3",
55 "ipv6": "2001:DB8::/64"
56 },
57 "insecure_disable_dnssec_validation": false,
58 "ip_categories": true,
59 "ip_indicator_feeds": true,
60 "l4override": {
61 "ip": "1.1.1.1"
62 },
63 "notification_settings": {},
64 "override_host": "example.com",
65 "override_ips": [
66 "1.1.1.1"
67 ],
68 "payload_log": {
69 "enabled": true
70 },
71 "resolve_dns_through_cloudflare": true,
72 "untrusted_cert": {
73 "action": "pass_through"
74 }
75 },
76 "schedule": {
77 "fri": "08:00-12:30,13:30-17:00",
78 "mon": "08:00-12:30,13:30-17:00",
79 "sat": "08:00-12:30,13:30-17:00",
80 "sun": "08:00-12:30,13:30-17:00",
81 "thu": "08:00-12:30,13:30-17:00",
82 "time_zone": "America/New York",
83 "tue": "08:00-12:30,13:30-17:00",
84 "wed": "08:00-12:30,13:30-17:00"
85 },
86 "traffic": "http.request.uri matches \".*a/partial/uri.*\" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10",
87 "updated_at": "2014-01-01T05:20:00.12345Z"
88 }
89 ]
90}