cloudflare 5.1.0 → 5.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +69 -0
- package/package.json +1 -1
- package/resources/addressing/prefixes/prefixes.d.ts +16 -8
- package/resources/addressing/prefixes/prefixes.d.ts.map +1 -1
- package/resources/addressing/prefixes/prefixes.js.map +1 -1
- package/resources/addressing/prefixes/prefixes.mjs.map +1 -1
- package/resources/ai/ai.d.ts +4 -0
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js +5 -0
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs +5 -0
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/index.d.ts +1 -0
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js +4 -1
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs +1 -0
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/to-markdown.d.ts +29 -0
- package/resources/ai/to-markdown.d.ts.map +1 -0
- package/resources/ai/to-markdown.js +27 -0
- package/resources/ai/to-markdown.js.map +1 -0
- package/resources/ai/to-markdown.mjs +22 -0
- package/resources/ai/to-markdown.mjs.map +1 -0
- package/resources/ai-gateway/ai-gateway.d.ts +204 -12
- package/resources/ai-gateway/ai-gateway.d.ts.map +1 -1
- package/resources/ai-gateway/ai-gateway.js.map +1 -1
- package/resources/ai-gateway/ai-gateway.mjs.map +1 -1
- package/resources/ai-gateway/logs.d.ts +2 -2
- package/resources/ai-gateway/logs.d.ts.map +1 -1
- package/resources/ai-gateway/logs.js.map +1 -1
- package/resources/ai-gateway/logs.mjs.map +1 -1
- package/resources/alerting/destinations/pagerduty.d.ts +9 -21
- package/resources/alerting/destinations/pagerduty.d.ts.map +1 -1
- package/resources/alerting/destinations/pagerduty.js.map +1 -1
- package/resources/alerting/destinations/pagerduty.mjs.map +1 -1
- package/resources/alerting/destinations/webhooks.d.ts +9 -21
- package/resources/alerting/destinations/webhooks.d.ts.map +1 -1
- package/resources/alerting/destinations/webhooks.js.map +1 -1
- package/resources/alerting/destinations/webhooks.mjs.map +1 -1
- package/resources/alerting/policies.d.ts +10 -3
- package/resources/alerting/policies.d.ts.map +1 -1
- package/resources/alerting/policies.js.map +1 -1
- package/resources/alerting/policies.mjs.map +1 -1
- package/resources/bot-management.d.ts +49 -0
- package/resources/bot-management.d.ts.map +1 -1
- package/resources/bot-management.js +1 -0
- package/resources/bot-management.js.map +1 -1
- package/resources/bot-management.mjs +1 -0
- package/resources/bot-management.mjs.map +1 -1
- package/resources/browser-rendering/json.d.ts +3 -3
- package/resources/browser-rendering/json.d.ts.map +1 -1
- package/resources/browser-rendering/links.d.ts +4 -0
- package/resources/browser-rendering/links.d.ts.map +1 -1
- package/resources/calls/turn.d.ts.map +1 -1
- package/resources/calls/turn.js +1 -1
- package/resources/calls/turn.js.map +1 -1
- package/resources/calls/turn.mjs +1 -1
- package/resources/calls/turn.mjs.map +1 -1
- package/resources/cloudforce-one/threat-events/crons.d.ts +0 -47
- package/resources/cloudforce-one/threat-events/crons.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/crons.js +0 -30
- package/resources/cloudforce-one/threat-events/crons.js.map +1 -1
- package/resources/cloudforce-one/threat-events/crons.mjs +0 -30
- package/resources/cloudforce-one/threat-events/crons.mjs.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/datasets.d.ts +2 -2
- package/resources/cloudforce-one/threat-events/datasets/datasets.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/datasets.js.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/datasets.mjs.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/health.d.ts +0 -120
- package/resources/cloudforce-one/threat-events/datasets/health.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/health.js +0 -16
- package/resources/cloudforce-one/threat-events/datasets/health.js.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/health.mjs +0 -16
- package/resources/cloudforce-one/threat-events/datasets/health.mjs.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/index.d.ts +1 -1
- package/resources/cloudforce-one/threat-events/datasets/index.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/index.js.map +1 -1
- package/resources/cloudforce-one/threat-events/datasets/index.mjs.map +1 -1
- package/resources/cloudforce-one/threat-events/index.d.ts +1 -1
- package/resources/cloudforce-one/threat-events/index.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/index.js.map +1 -1
- package/resources/cloudforce-one/threat-events/index.mjs +1 -1
- package/resources/cloudforce-one/threat-events/index.mjs.map +1 -1
- package/resources/cloudforce-one/threat-events/tags.d.ts +79 -4
- package/resources/cloudforce-one/threat-events/tags.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/tags.js +2 -2
- package/resources/cloudforce-one/threat-events/tags.mjs +2 -2
- package/resources/cloudforce-one/threat-events/threat-events.d.ts +27 -4
- package/resources/cloudforce-one/threat-events/threat-events.d.ts.map +1 -1
- package/resources/cloudforce-one/threat-events/threat-events.js +2 -0
- package/resources/cloudforce-one/threat-events/threat-events.js.map +1 -1
- package/resources/cloudforce-one/threat-events/threat-events.mjs +2 -0
- package/resources/cloudforce-one/threat-events/threat-events.mjs.map +1 -1
- package/resources/dns/dns.d.ts +4 -4
- package/resources/dns/dns.d.ts.map +1 -1
- package/resources/dns/dns.js +1 -0
- package/resources/dns/dns.js.map +1 -1
- package/resources/dns/dns.mjs +2 -1
- package/resources/dns/dns.mjs.map +1 -1
- package/resources/dns/index.d.ts +2 -2
- package/resources/dns/index.d.ts.map +1 -1
- package/resources/dns/index.js +2 -1
- package/resources/dns/index.js.map +1 -1
- package/resources/dns/index.mjs +1 -1
- package/resources/dns/index.mjs.map +1 -1
- package/resources/dns/records.d.ts +174 -5
- package/resources/dns/records.d.ts.map +1 -1
- package/resources/dns/records.js +60 -6
- package/resources/dns/records.js.map +1 -1
- package/resources/dns/records.mjs +59 -6
- package/resources/dns/records.mjs.map +1 -1
- package/resources/dns/settings/account/account.d.ts +48 -45
- package/resources/dns/settings/account/account.d.ts.map +1 -1
- package/resources/dns/settings/account/account.js.map +1 -1
- package/resources/dns/settings/account/account.mjs.map +1 -1
- package/resources/dns/settings/index.d.ts +1 -1
- package/resources/dns/settings/index.d.ts.map +1 -1
- package/resources/dns/settings/index.js.map +1 -1
- package/resources/dns/settings/index.mjs.map +1 -1
- package/resources/dns/settings/settings.d.ts +0 -87
- package/resources/dns/settings/settings.d.ts.map +1 -1
- package/resources/dns/settings/settings.js.map +1 -1
- package/resources/dns/settings/settings.mjs.map +1 -1
- package/resources/dns/settings/zone.d.ts +49 -46
- package/resources/dns/settings/zone.d.ts.map +1 -1
- package/resources/dns-firewall/dns-firewall.d.ts +156 -48
- package/resources/dns-firewall/dns-firewall.d.ts.map +1 -1
- package/resources/dns-firewall/dns-firewall.js.map +1 -1
- package/resources/dns-firewall/dns-firewall.mjs.map +1 -1
- package/resources/email-routing/dns.d.ts +2 -4
- package/resources/email-routing/dns.d.ts.map +1 -1
- package/resources/email-routing/dns.js +0 -2
- package/resources/email-routing/dns.js.map +1 -1
- package/resources/email-routing/dns.mjs +0 -2
- package/resources/email-routing/dns.mjs.map +1 -1
- package/resources/email-security/settings/domains.d.ts +6 -0
- package/resources/email-security/settings/domains.d.ts.map +1 -1
- package/resources/email-security/settings/domains.js.map +1 -1
- package/resources/email-security/settings/domains.mjs.map +1 -1
- package/resources/images/v1/stats.d.ts +3 -1
- package/resources/images/v1/stats.d.ts.map +1 -1
- package/resources/images/v1/stats.js +3 -1
- package/resources/images/v1/stats.js.map +1 -1
- package/resources/images/v1/stats.mjs +3 -1
- package/resources/images/v1/stats.mjs.map +1 -1
- package/resources/intel/indicator-feeds/downloads.d.ts +0 -36
- package/resources/intel/indicator-feeds/downloads.d.ts.map +1 -1
- package/resources/intel/indicator-feeds/downloads.js +0 -15
- package/resources/intel/indicator-feeds/downloads.js.map +1 -1
- package/resources/intel/indicator-feeds/downloads.mjs +0 -15
- package/resources/intel/indicator-feeds/downloads.mjs.map +1 -1
- package/resources/intel/indicator-feeds/index.d.ts +1 -1
- package/resources/intel/indicator-feeds/index.d.ts.map +1 -1
- package/resources/intel/indicator-feeds/index.js.map +1 -1
- package/resources/intel/indicator-feeds/index.mjs.map +1 -1
- package/resources/intel/indicator-feeds/indicator-feeds.d.ts +2 -2
- package/resources/intel/indicator-feeds/indicator-feeds.d.ts.map +1 -1
- package/resources/intel/indicator-feeds/indicator-feeds.js.map +1 -1
- package/resources/intel/indicator-feeds/indicator-feeds.mjs.map +1 -1
- package/resources/load-balancers/index.d.ts +1 -0
- package/resources/load-balancers/index.d.ts.map +1 -1
- package/resources/load-balancers/index.js +4 -1
- package/resources/load-balancers/index.js.map +1 -1
- package/resources/load-balancers/index.mjs +1 -0
- package/resources/load-balancers/index.mjs.map +1 -1
- package/resources/load-balancers/load-balancers.d.ts +4 -0
- package/resources/load-balancers/load-balancers.d.ts.map +1 -1
- package/resources/load-balancers/load-balancers.js +5 -0
- package/resources/load-balancers/load-balancers.js.map +1 -1
- package/resources/load-balancers/load-balancers.mjs +5 -0
- package/resources/load-balancers/load-balancers.mjs.map +1 -1
- package/resources/load-balancers/monitor-groups.d.ts +313 -0
- package/resources/load-balancers/monitor-groups.d.ts.map +1 -0
- package/resources/load-balancers/monitor-groups.js +153 -0
- package/resources/load-balancers/monitor-groups.js.map +1 -0
- package/resources/load-balancers/monitor-groups.mjs +148 -0
- package/resources/load-balancers/monitor-groups.mjs.map +1 -0
- package/resources/load-balancers/pools/pools.d.ts +20 -0
- package/resources/load-balancers/pools/pools.d.ts.map +1 -1
- package/resources/load-balancers/pools/pools.js.map +1 -1
- package/resources/load-balancers/pools/pools.mjs.map +1 -1
- package/resources/logs/rayid.d.ts +1 -1
- package/resources/logs/received/fields.d.ts +1 -1
- package/resources/logs/received/received.d.ts +1 -1
- package/resources/magic-transit/cf-interconnects.d.ts +25 -0
- package/resources/magic-transit/cf-interconnects.d.ts.map +1 -1
- package/resources/magic-transit/gre-tunnels.d.ts +40 -0
- package/resources/magic-transit/gre-tunnels.d.ts.map +1 -1
- package/resources/magic-transit/ipsec-tunnels.d.ts +124 -0
- package/resources/magic-transit/ipsec-tunnels.d.ts.map +1 -1
- package/resources/magic-transit/pcaps/download.d.ts +1 -1
- package/resources/magic-transit/pcaps/ownership.d.ts +4 -4
- package/resources/magic-transit/pcaps/pcaps.d.ts +6 -6
- package/resources/magic-transit/pcaps/pcaps.js +1 -1
- package/resources/magic-transit/pcaps/pcaps.mjs +1 -1
- package/resources/page-rules.d.ts +20 -4
- package/resources/page-rules.d.ts.map +1 -1
- package/resources/page-rules.js +20 -4
- package/resources/page-rules.js.map +1 -1
- package/resources/page-rules.mjs +20 -4
- package/resources/page-rules.mjs.map +1 -1
- package/resources/page-shield/connections.d.ts +1 -1
- package/resources/page-shield/cookies.d.ts +1 -1
- package/resources/page-shield/scripts.d.ts +1 -1
- package/resources/radar/ai/inference/summary.d.ts +2 -10
- package/resources/radar/ai/inference/summary.d.ts.map +1 -1
- package/resources/radar/ai/inference/summary.js.map +1 -1
- package/resources/radar/ai/inference/summary.mjs.map +1 -1
- package/resources/radar/ai/inference/timeseries-groups/summary.d.ts +2 -10
- package/resources/radar/ai/inference/timeseries-groups/summary.d.ts.map +1 -1
- package/resources/radar/ai/inference/timeseries-groups/summary.js.map +1 -1
- package/resources/radar/ai/inference/timeseries-groups/summary.mjs.map +1 -1
- package/resources/radar/entities/asns.d.ts +56 -1
- package/resources/radar/entities/asns.d.ts.map +1 -1
- package/resources/radar/entities/asns.js +6 -0
- package/resources/radar/entities/asns.js.map +1 -1
- package/resources/radar/entities/asns.mjs +6 -0
- package/resources/radar/entities/asns.mjs.map +1 -1
- package/resources/radar/entities/entities.d.ts +2 -2
- package/resources/radar/entities/entities.d.ts.map +1 -1
- package/resources/radar/entities/entities.js.map +1 -1
- package/resources/radar/entities/entities.mjs.map +1 -1
- package/resources/radar/entities/index.d.ts +1 -1
- package/resources/radar/entities/index.d.ts.map +1 -1
- package/resources/radar/entities/index.js.map +1 -1
- package/resources/radar/entities/index.mjs.map +1 -1
- package/resources/radar/http/ases/ases.d.ts +7 -0
- package/resources/radar/http/ases/ases.d.ts.map +1 -1
- package/resources/radar/http/ases/ases.js.map +1 -1
- package/resources/radar/http/ases/ases.mjs.map +1 -1
- package/resources/radar/http/ases/bot-class.d.ts +7 -0
- package/resources/radar/http/ases/bot-class.d.ts.map +1 -1
- package/resources/radar/http/ases/browser-family.d.ts +7 -0
- package/resources/radar/http/ases/browser-family.d.ts.map +1 -1
- package/resources/radar/http/ases/device-type.d.ts +7 -0
- package/resources/radar/http/ases/device-type.d.ts.map +1 -1
- package/resources/radar/http/ases/http-method.d.ts +7 -0
- package/resources/radar/http/ases/http-method.d.ts.map +1 -1
- package/resources/radar/http/ases/http-protocol.d.ts +7 -0
- package/resources/radar/http/ases/http-protocol.d.ts.map +1 -1
- package/resources/radar/http/ases/ip-version.d.ts +7 -0
- package/resources/radar/http/ases/ip-version.d.ts.map +1 -1
- package/resources/radar/http/ases/os.d.ts +7 -0
- package/resources/radar/http/ases/os.d.ts.map +1 -1
- package/resources/radar/http/ases/tls-version.d.ts +7 -0
- package/resources/radar/http/ases/tls-version.d.ts.map +1 -1
- package/resources/radar/http/http.d.ts +7 -0
- package/resources/radar/http/http.d.ts.map +1 -1
- package/resources/radar/http/http.js.map +1 -1
- package/resources/radar/http/http.mjs.map +1 -1
- package/resources/radar/http/locations/bot-class.d.ts +7 -0
- package/resources/radar/http/locations/bot-class.d.ts.map +1 -1
- package/resources/radar/http/locations/browser-family.d.ts +7 -0
- package/resources/radar/http/locations/browser-family.d.ts.map +1 -1
- package/resources/radar/http/locations/device-type.d.ts +7 -0
- package/resources/radar/http/locations/device-type.d.ts.map +1 -1
- package/resources/radar/http/locations/http-method.d.ts +7 -0
- package/resources/radar/http/locations/http-method.d.ts.map +1 -1
- package/resources/radar/http/locations/http-protocol.d.ts +7 -0
- package/resources/radar/http/locations/http-protocol.d.ts.map +1 -1
- package/resources/radar/http/locations/ip-version.d.ts +7 -0
- package/resources/radar/http/locations/ip-version.d.ts.map +1 -1
- package/resources/radar/http/locations/locations.d.ts +7 -0
- package/resources/radar/http/locations/locations.d.ts.map +1 -1
- package/resources/radar/http/locations/locations.js.map +1 -1
- package/resources/radar/http/locations/locations.mjs.map +1 -1
- package/resources/radar/http/locations/os.d.ts +7 -0
- package/resources/radar/http/locations/os.d.ts.map +1 -1
- package/resources/radar/http/locations/tls-version.d.ts +7 -0
- package/resources/radar/http/locations/tls-version.d.ts.map +1 -1
- package/resources/radar/http/summary.d.ts +64 -38
- package/resources/radar/http/summary.d.ts.map +1 -1
- package/resources/radar/http/summary.js.map +1 -1
- package/resources/radar/http/summary.mjs.map +1 -1
- package/resources/radar/http/timeseries-groups.d.ts +80 -50
- package/resources/radar/http/timeseries-groups.d.ts.map +1 -1
- package/resources/radar/http/timeseries-groups.js.map +1 -1
- package/resources/radar/http/timeseries-groups.mjs.map +1 -1
- package/resources/radar/http/top.d.ts +14 -0
- package/resources/radar/http/top.d.ts.map +1 -1
- package/resources/radar/leaked-credentials/summary.d.ts +2 -10
- package/resources/radar/leaked-credentials/summary.d.ts.map +1 -1
- package/resources/radar/leaked-credentials/summary.js.map +1 -1
- package/resources/radar/leaked-credentials/summary.mjs.map +1 -1
- package/resources/radar/leaked-credentials/timeseries-groups.d.ts +2 -10
- package/resources/radar/leaked-credentials/timeseries-groups.d.ts.map +1 -1
- package/resources/radar/leaked-credentials/timeseries-groups.js.map +1 -1
- package/resources/radar/leaked-credentials/timeseries-groups.mjs.map +1 -1
- package/resources/radar/netflows/netflows.d.ts +15 -4
- package/resources/radar/netflows/netflows.d.ts.map +1 -1
- package/resources/radar/netflows/netflows.js.map +1 -1
- package/resources/radar/netflows/netflows.mjs.map +1 -1
- package/resources/radar/netflows/top.d.ts +14 -0
- package/resources/radar/netflows/top.d.ts.map +1 -1
- package/resources/radar/search.d.ts +2 -2
- package/resources/radar/search.d.ts.map +1 -1
- package/resources/request-tracers/traces.d.ts +1 -1
- package/resources/resource-sharing/recipients.d.ts +77 -1
- package/resources/resource-sharing/recipients.d.ts.map +1 -1
- package/resources/resource-sharing/recipients.js +5 -2
- package/resources/resource-sharing/recipients.js.map +1 -1
- package/resources/resource-sharing/recipients.mjs +5 -2
- package/resources/resource-sharing/recipients.mjs.map +1 -1
- package/resources/resource-sharing/resource-sharing.d.ts +347 -2
- package/resources/resource-sharing/resource-sharing.d.ts.map +1 -1
- package/resources/resource-sharing/resource-sharing.js +5 -2
- package/resources/resource-sharing/resource-sharing.js.map +1 -1
- package/resources/resource-sharing/resource-sharing.mjs +5 -2
- package/resources/resource-sharing/resource-sharing.mjs.map +1 -1
- package/resources/resource-sharing/resources.d.ts +7 -7
- package/resources/resource-sharing/resources.d.ts.map +1 -1
- package/resources/resource-sharing/resources.js.map +1 -1
- package/resources/resource-sharing/resources.mjs.map +1 -1
- package/resources/rules/lists/items.d.ts +9 -0
- package/resources/rules/lists/items.d.ts.map +1 -1
- package/resources/rules/lists/items.js +9 -0
- package/resources/rules/lists/items.js.map +1 -1
- package/resources/rules/lists/items.mjs +9 -0
- package/resources/rules/lists/items.mjs.map +1 -1
- package/resources/snippets/snippets.d.ts +1 -4
- package/resources/snippets/snippets.d.ts.map +1 -1
- package/resources/snippets/snippets.js.map +1 -1
- package/resources/snippets/snippets.mjs.map +1 -1
- package/resources/stream/downloads.d.ts +4 -2
- package/resources/stream/downloads.d.ts.map +1 -1
- package/resources/stream/downloads.js +4 -2
- package/resources/stream/downloads.js.map +1 -1
- package/resources/stream/downloads.mjs +4 -2
- package/resources/stream/downloads.mjs.map +1 -1
- package/resources/workers/beta/beta.d.ts +2 -2
- package/resources/workers/beta/beta.d.ts.map +1 -1
- package/resources/workers/beta/beta.js.map +1 -1
- package/resources/workers/beta/beta.mjs.map +1 -1
- package/resources/workers/beta/index.d.ts +1 -1
- package/resources/workers/beta/index.d.ts.map +1 -1
- package/resources/workers/beta/index.js.map +1 -1
- package/resources/workers/beta/index.mjs.map +1 -1
- package/resources/workers/beta/workers/index.d.ts +1 -1
- package/resources/workers/beta/workers/index.d.ts.map +1 -1
- package/resources/workers/beta/workers/index.js.map +1 -1
- package/resources/workers/beta/workers/index.mjs.map +1 -1
- package/resources/workers/beta/workers/versions.d.ts +276 -17
- package/resources/workers/beta/workers/versions.d.ts.map +1 -1
- package/resources/workers/beta/workers/versions.js +8 -7
- package/resources/workers/beta/workers/versions.js.map +1 -1
- package/resources/workers/beta/workers/versions.mjs +8 -7
- package/resources/workers/beta/workers/versions.mjs.map +1 -1
- package/resources/workers/beta/workers/workers.d.ts +133 -18
- package/resources/workers/beta/workers/workers.d.ts.map +1 -1
- package/resources/workers/beta/workers/workers.js +35 -4
- package/resources/workers/beta/workers/workers.js.map +1 -1
- package/resources/workers/beta/workers/workers.mjs +35 -4
- package/resources/workers/beta/workers/workers.mjs.map +1 -1
- package/resources/workers/index.d.ts +1 -1
- package/resources/workers/index.d.ts.map +1 -1
- package/resources/workers/index.js.map +1 -1
- package/resources/workers/index.mjs.map +1 -1
- package/resources/workers/scripts/index.d.ts +1 -1
- package/resources/workers/scripts/index.d.ts.map +1 -1
- package/resources/workers/scripts/index.js.map +1 -1
- package/resources/workers/scripts/index.mjs.map +1 -1
- package/resources/workers/scripts/script-and-version-settings.d.ts +354 -15
- package/resources/workers/scripts/script-and-version-settings.d.ts.map +1 -1
- package/resources/workers/scripts/scripts.d.ts +206 -10
- package/resources/workers/scripts/scripts.d.ts.map +1 -1
- package/resources/workers/scripts/scripts.js +17 -0
- package/resources/workers/scripts/scripts.js.map +1 -1
- package/resources/workers/scripts/scripts.mjs +17 -0
- package/resources/workers/scripts/scripts.mjs.map +1 -1
- package/resources/workers/scripts/secrets.d.ts +10 -2
- package/resources/workers/scripts/secrets.d.ts.map +1 -1
- package/resources/workers/scripts/secrets.js +10 -4
- package/resources/workers/scripts/secrets.js.map +1 -1
- package/resources/workers/scripts/secrets.mjs +10 -4
- package/resources/workers/scripts/secrets.mjs.map +1 -1
- package/resources/workers/scripts/settings.d.ts +12 -0
- package/resources/workers/scripts/settings.d.ts.map +1 -1
- package/resources/workers/scripts/versions.d.ts +327 -12
- package/resources/workers/scripts/versions.d.ts.map +1 -1
- package/resources/workers/scripts/versions.js.map +1 -1
- package/resources/workers/scripts/versions.mjs.map +1 -1
- package/resources/workers/workers.d.ts +2 -2
- package/resources/workers/workers.d.ts.map +1 -1
- package/resources/workers/workers.js.map +1 -1
- package/resources/workers/workers.mjs.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.d.ts +109 -4
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.d.ts.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.js.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.mjs.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.d.ts +121 -9
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.d.ts.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.js.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.mjs.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.d.ts +10 -2
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.d.ts.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.js +4 -4
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.js.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.mjs +4 -4
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.mjs.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.d.ts +354 -15
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.d.ts.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.d.ts +2 -8
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.d.ts.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.js +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.js.map +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.mjs +1 -1
- package/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.mjs.map +1 -1
- package/resources/workflows/instances/instances.d.ts +5 -0
- package/resources/workflows/instances/instances.d.ts.map +1 -1
- package/resources/workflows/instances/instances.js.map +1 -1
- package/resources/workflows/instances/instances.mjs.map +1 -1
- package/resources/zero-trust/access/applications/applications.d.ts +0 -84
- package/resources/zero-trust/access/applications/applications.d.ts.map +1 -1
- package/resources/zero-trust/access/applications/applications.js.map +1 -1
- package/resources/zero-trust/access/applications/applications.mjs.map +1 -1
- package/resources/zero-trust/access/bookmarks.d.ts +0 -2
- package/resources/zero-trust/access/bookmarks.d.ts.map +1 -1
- package/resources/zero-trust/access/bookmarks.js.map +1 -1
- package/resources/zero-trust/access/bookmarks.mjs.map +1 -1
- package/resources/zero-trust/access/certificates/certificates.d.ts +0 -2
- package/resources/zero-trust/access/certificates/certificates.d.ts.map +1 -1
- package/resources/zero-trust/access/certificates/certificates.js.map +1 -1
- package/resources/zero-trust/access/certificates/certificates.mjs.map +1 -1
- package/resources/zero-trust/access/custom-pages.d.ts +0 -20
- package/resources/zero-trust/access/custom-pages.d.ts.map +1 -1
- package/resources/zero-trust/access/custom-pages.js.map +1 -1
- package/resources/zero-trust/access/custom-pages.mjs.map +1 -1
- package/resources/zero-trust/access/groups.d.ts +0 -8
- package/resources/zero-trust/access/groups.d.ts.map +1 -1
- package/resources/zero-trust/access/groups.js.map +1 -1
- package/resources/zero-trust/access/groups.mjs.map +1 -1
- package/resources/zero-trust/access/service-tokens.d.ts +37 -8
- package/resources/zero-trust/access/service-tokens.d.ts.map +1 -1
- package/resources/zero-trust/access/service-tokens.js +5 -2
- package/resources/zero-trust/access/service-tokens.js.map +1 -1
- package/resources/zero-trust/access/service-tokens.mjs +5 -2
- package/resources/zero-trust/access/service-tokens.mjs.map +1 -1
- package/resources/zero-trust/access/tags.d.ts +0 -6
- package/resources/zero-trust/access/tags.d.ts.map +1 -1
- package/resources/zero-trust/access/tags.js.map +1 -1
- package/resources/zero-trust/access/tags.mjs.map +1 -1
- package/resources/zero-trust/devices/devices_.d.ts +94 -1
- package/resources/zero-trust/devices/devices_.d.ts.map +1 -1
- package/resources/zero-trust/devices/devices_.js +5 -2
- package/resources/zero-trust/devices/devices_.js.map +1 -1
- package/resources/zero-trust/devices/devices_.mjs +5 -2
- package/resources/zero-trust/devices/devices_.mjs.map +1 -1
- package/resources/zero-trust/devices/registrations.d.ts +70 -1
- package/resources/zero-trust/devices/registrations.d.ts.map +1 -1
- package/resources/zero-trust/devices/registrations.js +5 -2
- package/resources/zero-trust/devices/registrations.js.map +1 -1
- package/resources/zero-trust/devices/registrations.mjs +5 -2
- package/resources/zero-trust/devices/registrations.mjs.map +1 -1
- package/resources/zero-trust/gateway/app-types.d.ts +10 -10
- package/resources/zero-trust/gateway/app-types.js +1 -1
- package/resources/zero-trust/gateway/app-types.mjs +1 -1
- package/resources/zero-trust/gateway/audit-ssh-settings.d.ts +11 -11
- package/resources/zero-trust/gateway/audit-ssh-settings.js +5 -5
- package/resources/zero-trust/gateway/audit-ssh-settings.mjs +5 -5
- package/resources/zero-trust/gateway/categories.d.ts +17 -19
- package/resources/zero-trust/gateway/categories.d.ts.map +1 -1
- package/resources/zero-trust/gateway/categories.js +1 -1
- package/resources/zero-trust/gateway/categories.js.map +1 -1
- package/resources/zero-trust/gateway/categories.mjs +1 -1
- package/resources/zero-trust/gateway/categories.mjs.map +1 -1
- package/resources/zero-trust/gateway/certificates.d.ts +84 -83
- package/resources/zero-trust/gateway/certificates.d.ts.map +1 -1
- package/resources/zero-trust/gateway/certificates.js +7 -7
- package/resources/zero-trust/gateway/certificates.js.map +1 -1
- package/resources/zero-trust/gateway/certificates.mjs +7 -7
- package/resources/zero-trust/gateway/certificates.mjs.map +1 -1
- package/resources/zero-trust/gateway/configurations/configurations.d.ts +212 -192
- package/resources/zero-trust/gateway/configurations/configurations.d.ts.map +1 -1
- package/resources/zero-trust/gateway/configurations/configurations.js +7 -7
- package/resources/zero-trust/gateway/configurations/configurations.js.map +1 -1
- package/resources/zero-trust/gateway/configurations/configurations.mjs +7 -7
- package/resources/zero-trust/gateway/configurations/configurations.mjs.map +1 -1
- package/resources/zero-trust/gateway/configurations/custom-certificate.d.ts +1 -1
- package/resources/zero-trust/gateway/configurations/custom-certificate.js +1 -1
- package/resources/zero-trust/gateway/configurations/custom-certificate.mjs +1 -1
- package/resources/zero-trust/gateway/gateway.d.ts +8 -8
- package/resources/zero-trust/gateway/gateway.js +2 -2
- package/resources/zero-trust/gateway/gateway.mjs +2 -2
- package/resources/zero-trust/gateway/lists/items.d.ts +2 -2
- package/resources/zero-trust/gateway/lists/items.js +1 -1
- package/resources/zero-trust/gateway/lists/items.mjs +1 -1
- package/resources/zero-trust/gateway/lists/lists.d.ts +32 -32
- package/resources/zero-trust/gateway/lists/lists.js +3 -3
- package/resources/zero-trust/gateway/lists/lists.mjs +3 -3
- package/resources/zero-trust/gateway/locations.d.ts +84 -98
- package/resources/zero-trust/gateway/locations.d.ts.map +1 -1
- package/resources/zero-trust/gateway/locations.js +5 -5
- package/resources/zero-trust/gateway/locations.js.map +1 -1
- package/resources/zero-trust/gateway/locations.mjs +5 -5
- package/resources/zero-trust/gateway/locations.mjs.map +1 -1
- package/resources/zero-trust/gateway/logging.d.ts +60 -23
- package/resources/zero-trust/gateway/logging.d.ts.map +1 -1
- package/resources/zero-trust/gateway/logging.js +2 -2
- package/resources/zero-trust/gateway/logging.mjs +2 -2
- package/resources/zero-trust/gateway/proxy-endpoints.d.ts +16 -16
- package/resources/zero-trust/gateway/proxy-endpoints.js +5 -5
- package/resources/zero-trust/gateway/proxy-endpoints.mjs +5 -5
- package/resources/zero-trust/gateway/rules.d.ts +514 -439
- package/resources/zero-trust/gateway/rules.d.ts.map +1 -1
- package/resources/zero-trust/gateway/rules.js +8 -10
- package/resources/zero-trust/gateway/rules.js.map +1 -1
- package/resources/zero-trust/gateway/rules.mjs +8 -10
- package/resources/zero-trust/gateway/rules.mjs.map +1 -1
- package/resources/zero-trust/networks/hostname-routes.d.ts +188 -0
- package/resources/zero-trust/networks/hostname-routes.d.ts.map +1 -0
- package/resources/zero-trust/networks/hostname-routes.js +100 -0
- package/resources/zero-trust/networks/hostname-routes.js.map +1 -0
- package/resources/zero-trust/networks/hostname-routes.mjs +95 -0
- package/resources/zero-trust/networks/hostname-routes.mjs.map +1 -0
- package/resources/zero-trust/networks/index.d.ts +1 -0
- package/resources/zero-trust/networks/index.d.ts.map +1 -1
- package/resources/zero-trust/networks/index.js +4 -1
- package/resources/zero-trust/networks/index.js.map +1 -1
- package/resources/zero-trust/networks/index.mjs +1 -0
- package/resources/zero-trust/networks/index.mjs.map +1 -1
- package/resources/zero-trust/networks/networks.d.ts +4 -0
- package/resources/zero-trust/networks/networks.d.ts.map +1 -1
- package/resources/zero-trust/networks/networks.js +5 -0
- package/resources/zero-trust/networks/networks.js.map +1 -1
- package/resources/zero-trust/networks/networks.mjs +5 -0
- package/resources/zero-trust/networks/networks.mjs.map +1 -1
- package/resources/zero-trust/organizations/doh.d.ts +0 -6
- package/resources/zero-trust/organizations/doh.d.ts.map +1 -1
- package/resources/zero-trust/organizations/organizations.d.ts +0 -2
- package/resources/zero-trust/organizations/organizations.d.ts.map +1 -1
- package/resources/zero-trust/organizations/organizations.js.map +1 -1
- package/resources/zero-trust/organizations/organizations.mjs.map +1 -1
- package/resources/zero-trust/tunnels/cloudflared/configurations.d.ts +0 -24
- package/resources/zero-trust/tunnels/cloudflared/configurations.d.ts.map +1 -1
- package/src/resources/addressing/prefixes/prefixes.ts +16 -8
- package/src/resources/ai/ai.ts +17 -0
- package/src/resources/ai/index.ts +6 -0
- package/src/resources/ai/to-markdown.ts +61 -0
- package/src/resources/ai-gateway/ai-gateway.ts +282 -12
- package/src/resources/ai-gateway/logs.ts +4 -2
- package/src/resources/alerting/destinations/pagerduty.ts +12 -25
- package/src/resources/alerting/destinations/webhooks.ts +12 -25
- package/src/resources/alerting/policies.ts +14 -3
- package/src/resources/bot-management.ts +61 -0
- package/src/resources/browser-rendering/json.ts +1 -1
- package/src/resources/browser-rendering/links.ts +5 -0
- package/src/resources/calls/turn.ts +5 -1
- package/src/resources/cloudforce-one/threat-events/crons.ts +1 -67
- package/src/resources/cloudforce-one/threat-events/datasets/datasets.ts +2 -6
- package/src/resources/cloudforce-one/threat-events/datasets/health.ts +1 -175
- package/src/resources/cloudforce-one/threat-events/datasets/index.ts +1 -1
- package/src/resources/cloudforce-one/threat-events/index.ts +1 -7
- package/src/resources/cloudforce-one/threat-events/tags.ts +110 -5
- package/src/resources/cloudforce-one/threat-events/threat-events.ts +45 -10
- package/src/resources/dns/dns.ts +15 -2
- package/src/resources/dns/index.ts +7 -1
- package/src/resources/dns/records.ts +267 -8
- package/src/resources/dns/settings/account/account.ts +48 -45
- package/src/resources/dns/settings/index.ts +1 -1
- package/src/resources/dns/settings/settings.ts +0 -104
- package/src/resources/dns/settings/zone.ts +49 -46
- package/src/resources/dns-firewall/dns-firewall.ts +156 -48
- package/src/resources/email-routing/dns.ts +2 -4
- package/src/resources/email-security/settings/domains.ts +12 -0
- package/src/resources/images/v1/stats.ts +3 -1
- package/src/resources/intel/indicator-feeds/downloads.ts +1 -55
- package/src/resources/intel/indicator-feeds/index.ts +1 -1
- package/src/resources/intel/indicator-feeds/indicator-feeds.ts +2 -6
- package/src/resources/load-balancers/index.ts +11 -0
- package/src/resources/load-balancers/load-balancers.ts +27 -0
- package/src/resources/load-balancers/monitor-groups.ts +436 -0
- package/src/resources/load-balancers/pools/pools.ts +24 -0
- package/src/resources/logs/rayid.ts +1 -1
- package/src/resources/logs/received/fields.ts +1 -1
- package/src/resources/logs/received/received.ts +1 -1
- package/src/resources/magic-transit/cf-interconnects.ts +30 -0
- package/src/resources/magic-transit/gre-tunnels.ts +48 -0
- package/src/resources/magic-transit/ipsec-tunnels.ts +144 -0
- package/src/resources/magic-transit/pcaps/download.ts +1 -1
- package/src/resources/magic-transit/pcaps/ownership.ts +4 -4
- package/src/resources/magic-transit/pcaps/pcaps.ts +6 -6
- package/src/resources/page-rules.ts +20 -4
- package/src/resources/page-shield/connections.ts +1 -1
- package/src/resources/page-shield/cookies.ts +1 -1
- package/src/resources/page-shield/scripts.ts +1 -1
- package/src/resources/radar/ai/inference/summary.ts +2 -10
- package/src/resources/radar/ai/inference/timeseries-groups/summary.ts +2 -10
- package/src/resources/radar/entities/asns.ts +86 -0
- package/src/resources/radar/entities/entities.ts +4 -0
- package/src/resources/radar/entities/index.ts +2 -0
- package/src/resources/radar/http/ases/ases.ts +8 -0
- package/src/resources/radar/http/ases/bot-class.ts +8 -0
- package/src/resources/radar/http/ases/browser-family.ts +8 -0
- package/src/resources/radar/http/ases/device-type.ts +8 -0
- package/src/resources/radar/http/ases/http-method.ts +8 -0
- package/src/resources/radar/http/ases/http-protocol.ts +8 -0
- package/src/resources/radar/http/ases/ip-version.ts +8 -0
- package/src/resources/radar/http/ases/os.ts +8 -0
- package/src/resources/radar/http/ases/tls-version.ts +8 -0
- package/src/resources/radar/http/http.ts +8 -0
- package/src/resources/radar/http/locations/bot-class.ts +8 -0
- package/src/resources/radar/http/locations/browser-family.ts +8 -0
- package/src/resources/radar/http/locations/device-type.ts +8 -0
- package/src/resources/radar/http/locations/http-method.ts +8 -0
- package/src/resources/radar/http/locations/http-protocol.ts +8 -0
- package/src/resources/radar/http/locations/ip-version.ts +8 -0
- package/src/resources/radar/http/locations/locations.ts +8 -0
- package/src/resources/radar/http/locations/os.ts +8 -0
- package/src/resources/radar/http/locations/tls-version.ts +8 -0
- package/src/resources/radar/http/summary.ts +72 -38
- package/src/resources/radar/http/timeseries-groups.ts +90 -50
- package/src/resources/radar/http/top.ts +16 -0
- package/src/resources/radar/leaked-credentials/summary.ts +2 -10
- package/src/resources/radar/leaked-credentials/timeseries-groups.ts +2 -10
- package/src/resources/radar/netflows/netflows.ts +17 -4
- package/src/resources/radar/netflows/top.ts +16 -0
- package/src/resources/radar/search.ts +2 -0
- package/src/resources/request-tracers/traces.ts +1 -1
- package/src/resources/resource-sharing/recipients.ts +100 -6
- package/src/resources/resource-sharing/resource-sharing.ts +470 -6
- package/src/resources/resource-sharing/resources.ts +49 -7
- package/src/resources/rules/lists/items.ts +9 -0
- package/src/resources/snippets/snippets.ts +2 -5
- package/src/resources/stream/downloads.ts +4 -2
- package/src/resources/workers/beta/beta.ts +2 -0
- package/src/resources/workers/beta/index.ts +1 -0
- package/src/resources/workers/beta/workers/index.ts +1 -0
- package/src/resources/workers/beta/workers/versions.ts +331 -16
- package/src/resources/workers/beta/workers/workers.ts +160 -18
- package/src/resources/workers/index.ts +2 -0
- package/src/resources/workers/scripts/index.ts +2 -0
- package/src/resources/workers/scripts/script-and-version-settings.ts +438 -12
- package/src/resources/workers/scripts/scripts.ts +261 -8
- package/src/resources/workers/scripts/secrets.ts +22 -12
- package/src/resources/workers/scripts/settings.ts +15 -0
- package/src/resources/workers/scripts/versions.ts +405 -9
- package/src/resources/workers/workers.ts +4 -0
- package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.ts +136 -4
- package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts +149 -8
- package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.ts +16 -6
- package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts +438 -12
- package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts +2 -8
- package/src/resources/workflows/instances/instances.ts +6 -0
- package/src/resources/zero-trust/access/applications/applications.ts +0 -168
- package/src/resources/zero-trust/access/bookmarks.ts +0 -4
- package/src/resources/zero-trust/access/certificates/certificates.ts +0 -4
- package/src/resources/zero-trust/access/custom-pages.ts +0 -28
- package/src/resources/zero-trust/access/groups.ts +0 -16
- package/src/resources/zero-trust/access/service-tokens.ts +47 -20
- package/src/resources/zero-trust/access/tags.ts +0 -9
- package/src/resources/zero-trust/devices/devices_.ts +114 -6
- package/src/resources/zero-trust/devices/registrations.ts +88 -6
- package/src/resources/zero-trust/gateway/app-types.ts +10 -10
- package/src/resources/zero-trust/gateway/audit-ssh-settings.ts +11 -11
- package/src/resources/zero-trust/gateway/categories.ts +17 -19
- package/src/resources/zero-trust/gateway/certificates.ts +84 -83
- package/src/resources/zero-trust/gateway/configurations/configurations.ts +212 -192
- package/src/resources/zero-trust/gateway/configurations/custom-certificate.ts +1 -1
- package/src/resources/zero-trust/gateway/gateway.ts +8 -8
- package/src/resources/zero-trust/gateway/lists/items.ts +2 -2
- package/src/resources/zero-trust/gateway/lists/lists.ts +32 -32
- package/src/resources/zero-trust/gateway/locations.ts +84 -98
- package/src/resources/zero-trust/gateway/logging.ts +60 -23
- package/src/resources/zero-trust/gateway/proxy-endpoints.ts +16 -16
- package/src/resources/zero-trust/gateway/rules.ts +515 -440
- package/src/resources/zero-trust/networks/hostname-routes.ts +283 -0
- package/src/resources/zero-trust/networks/index.ts +10 -0
- package/src/resources/zero-trust/networks/networks.ts +25 -0
- package/src/resources/zero-trust/organizations/doh.ts +0 -12
- package/src/resources/zero-trust/organizations/organizations.ts +0 -4
- package/src/resources/zero-trust/tunnels/cloudflared/configurations.ts +0 -28
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -4,7 +4,7 @@ import * as RulesAPI from "./rules.js";
|
|
|
4
4
|
import { SinglePage } from "../../../pagination.js";
|
|
5
5
|
export declare class Rules extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Create a new Zero Trust Gateway rule.
|
|
8
8
|
*
|
|
9
9
|
* @example
|
|
10
10
|
* ```ts
|
|
@@ -18,7 +18,7 @@ export declare class Rules extends APIResource {
|
|
|
18
18
|
*/
|
|
19
19
|
create(params: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<GatewayRule>;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Update a configured Zero Trust Gateway rule.
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
24
|
* ```ts
|
|
@@ -35,7 +35,7 @@ export declare class Rules extends APIResource {
|
|
|
35
35
|
*/
|
|
36
36
|
update(ruleId: string, params: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<GatewayRule>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* List Zero Trust Gateway rules for an account.
|
|
39
39
|
*
|
|
40
40
|
* @example
|
|
41
41
|
* ```ts
|
|
@@ -49,7 +49,7 @@ export declare class Rules extends APIResource {
|
|
|
49
49
|
*/
|
|
50
50
|
list(params: RuleListParams, options?: Core.RequestOptions): Core.PagePromise<GatewayRulesSinglePage, GatewayRule>;
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
* Delete a Zero Trust Gateway rule.
|
|
53
53
|
*
|
|
54
54
|
* @example
|
|
55
55
|
* ```ts
|
|
@@ -61,7 +61,7 @@ export declare class Rules extends APIResource {
|
|
|
61
61
|
*/
|
|
62
62
|
delete(ruleId: string, params: RuleDeleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
|
|
63
63
|
/**
|
|
64
|
-
*
|
|
64
|
+
* Get a single Zero Trust Gateway rule.
|
|
65
65
|
*
|
|
66
66
|
* @example
|
|
67
67
|
* ```ts
|
|
@@ -74,11 +74,9 @@ export declare class Rules extends APIResource {
|
|
|
74
74
|
*/
|
|
75
75
|
get(ruleId: string, params: RuleGetParams, options?: Core.RequestOptions): Core.APIPromise<GatewayRule>;
|
|
76
76
|
/**
|
|
77
|
-
* Resets the expiration of a Zero Trust Gateway Rule if its duration
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* The Zero Trust Gateway Rule must have values for both `expiration.expires_at`
|
|
81
|
-
* and `expiration.duration`.
|
|
77
|
+
* Resets the expiration of a Zero Trust Gateway Rule if its duration elapsed and
|
|
78
|
+
* it has a default duration. The Zero Trust Gateway Rule must have values for both
|
|
79
|
+
* `expiration.expires_at` and `expiration.duration`.
|
|
82
80
|
*
|
|
83
81
|
* @example
|
|
84
82
|
* ```ts
|
|
@@ -95,364 +93,393 @@ export declare class GatewayRulesSinglePage extends SinglePage<GatewayRule> {
|
|
|
95
93
|
}
|
|
96
94
|
export interface DNSResolverSettingsV4 {
|
|
97
95
|
/**
|
|
98
|
-
* IPv4 address of upstream resolver.
|
|
96
|
+
* Specify the IPv4 address of the upstream resolver.
|
|
99
97
|
*/
|
|
100
98
|
ip: string;
|
|
101
99
|
/**
|
|
102
|
-
*
|
|
100
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if
|
|
101
|
+
* unspecified.
|
|
103
102
|
*/
|
|
104
103
|
port?: number;
|
|
105
104
|
/**
|
|
106
|
-
*
|
|
107
|
-
* vnet_id
|
|
105
|
+
* Indicate whether to connect to this resolver over a private network. Must set
|
|
106
|
+
* when vnet_id set.
|
|
108
107
|
*/
|
|
109
108
|
route_through_private_network?: boolean;
|
|
110
109
|
/**
|
|
111
|
-
*
|
|
110
|
+
* Specify an optional virtual network for this resolver. Uses default virtual
|
|
112
111
|
* network id if omitted.
|
|
113
112
|
*/
|
|
114
113
|
vnet_id?: string;
|
|
115
114
|
}
|
|
116
115
|
export interface DNSResolverSettingsV4Param {
|
|
117
116
|
/**
|
|
118
|
-
* IPv4 address of upstream resolver.
|
|
117
|
+
* Specify the IPv4 address of the upstream resolver.
|
|
119
118
|
*/
|
|
120
119
|
ip: string;
|
|
121
120
|
/**
|
|
122
|
-
*
|
|
121
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if
|
|
122
|
+
* unspecified.
|
|
123
123
|
*/
|
|
124
124
|
port?: number;
|
|
125
125
|
/**
|
|
126
|
-
*
|
|
127
|
-
* vnet_id
|
|
126
|
+
* Indicate whether to connect to this resolver over a private network. Must set
|
|
127
|
+
* when vnet_id set.
|
|
128
128
|
*/
|
|
129
129
|
route_through_private_network?: boolean;
|
|
130
130
|
/**
|
|
131
|
-
*
|
|
131
|
+
* Specify an optional virtual network for this resolver. Uses default virtual
|
|
132
132
|
* network id if omitted.
|
|
133
133
|
*/
|
|
134
134
|
vnet_id?: string;
|
|
135
135
|
}
|
|
136
136
|
export interface DNSResolverSettingsV6 {
|
|
137
137
|
/**
|
|
138
|
-
* IPv6 address of upstream resolver.
|
|
138
|
+
* Specify the IPv6 address of the upstream resolver.
|
|
139
139
|
*/
|
|
140
140
|
ip: string;
|
|
141
141
|
/**
|
|
142
|
-
*
|
|
142
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if
|
|
143
|
+
* unspecified.
|
|
143
144
|
*/
|
|
144
145
|
port?: number;
|
|
145
146
|
/**
|
|
146
|
-
*
|
|
147
|
-
* vnet_id
|
|
147
|
+
* Indicate whether to connect to this resolver over a private network. Must set
|
|
148
|
+
* when vnet_id set.
|
|
148
149
|
*/
|
|
149
150
|
route_through_private_network?: boolean;
|
|
150
151
|
/**
|
|
151
|
-
*
|
|
152
|
+
* Specify an optional virtual network for this resolver. Uses default virtual
|
|
152
153
|
* network id if omitted.
|
|
153
154
|
*/
|
|
154
155
|
vnet_id?: string;
|
|
155
156
|
}
|
|
156
157
|
export interface DNSResolverSettingsV6Param {
|
|
157
158
|
/**
|
|
158
|
-
* IPv6 address of upstream resolver.
|
|
159
|
+
* Specify the IPv6 address of the upstream resolver.
|
|
159
160
|
*/
|
|
160
161
|
ip: string;
|
|
161
162
|
/**
|
|
162
|
-
*
|
|
163
|
+
* Specify a port number to use for the upstream resolver. Defaults to 53 if
|
|
164
|
+
* unspecified.
|
|
163
165
|
*/
|
|
164
166
|
port?: number;
|
|
165
167
|
/**
|
|
166
|
-
*
|
|
167
|
-
* vnet_id
|
|
168
|
+
* Indicate whether to connect to this resolver over a private network. Must set
|
|
169
|
+
* when vnet_id set.
|
|
168
170
|
*/
|
|
169
171
|
route_through_private_network?: boolean;
|
|
170
172
|
/**
|
|
171
|
-
*
|
|
173
|
+
* Specify an optional virtual network for this resolver. Uses default virtual
|
|
172
174
|
* network id if omitted.
|
|
173
175
|
*/
|
|
174
176
|
vnet_id?: string;
|
|
175
177
|
}
|
|
176
178
|
/**
|
|
177
|
-
*
|
|
179
|
+
* Specify the protocol or layer to use.
|
|
178
180
|
*/
|
|
179
181
|
export type GatewayFilter = 'http' | 'dns' | 'l4' | 'egress' | 'dns_resolver';
|
|
180
182
|
/**
|
|
181
|
-
*
|
|
183
|
+
* Specify the protocol or layer to use.
|
|
182
184
|
*/
|
|
183
185
|
export type GatewayFilterParam = 'http' | 'dns' | 'l4' | 'egress' | 'dns_resolver';
|
|
184
186
|
export interface GatewayRule {
|
|
185
187
|
/**
|
|
186
|
-
*
|
|
187
|
-
* expressions
|
|
188
|
+
* Specify the action to perform when the associated traffic, identity, and device
|
|
189
|
+
* posture expressions either absent or evaluate to `true`.
|
|
188
190
|
*/
|
|
189
191
|
action: 'on' | 'off' | 'allow' | 'block' | 'scan' | 'noscan' | 'safesearch' | 'ytrestricted' | 'isolate' | 'noisolate' | 'override' | 'l4_override' | 'egress' | 'resolve' | 'quarantine' | 'redirect';
|
|
190
192
|
/**
|
|
191
|
-
*
|
|
193
|
+
* Specify whether the rule is enabled.
|
|
192
194
|
*/
|
|
193
195
|
enabled: boolean;
|
|
194
196
|
/**
|
|
195
|
-
*
|
|
196
|
-
* expressions.
|
|
197
|
+
* Specify the protocol or layer to evaluate the traffic, identity, and device
|
|
198
|
+
* posture expressions.
|
|
197
199
|
*/
|
|
198
200
|
filters: Array<GatewayFilter>;
|
|
199
201
|
/**
|
|
200
|
-
*
|
|
202
|
+
* Specify the rule name.
|
|
201
203
|
*/
|
|
202
204
|
name: string;
|
|
203
205
|
/**
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
206
|
+
* Set the order of your rules. Lower values indicate higher precedence. At each
|
|
207
|
+
* processing phase, evaluate applicable rules in ascending order of this value.
|
|
208
|
+
* Refer to
|
|
207
209
|
* [Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
|
|
208
|
-
*
|
|
210
|
+
* to manage precedence via Terraform.
|
|
209
211
|
*/
|
|
210
212
|
precedence: number;
|
|
211
213
|
/**
|
|
212
|
-
*
|
|
213
|
-
* formats and sanitizes
|
|
214
|
-
*
|
|
214
|
+
* Specify the wirefilter expression used for traffic matching. The API
|
|
215
|
+
* automatically formats and sanitizes expressions before storing them. To prevent
|
|
216
|
+
* Terraform state drift, use the formatted expression returned in the API
|
|
217
|
+
* response.
|
|
215
218
|
*/
|
|
216
219
|
traffic: string;
|
|
217
220
|
/**
|
|
218
|
-
*
|
|
221
|
+
* Identify the API resource with a UUID.
|
|
219
222
|
*/
|
|
220
223
|
id?: string;
|
|
221
224
|
created_at?: string;
|
|
222
225
|
/**
|
|
223
|
-
*
|
|
226
|
+
* Indicate the date of deletion, if any.
|
|
224
227
|
*/
|
|
225
228
|
deleted_at?: string | null;
|
|
226
229
|
/**
|
|
227
|
-
*
|
|
230
|
+
* Specify the rule description.
|
|
228
231
|
*/
|
|
229
232
|
description?: string;
|
|
230
233
|
/**
|
|
231
|
-
*
|
|
232
|
-
* automatically formats and sanitizes
|
|
233
|
-
*
|
|
234
|
+
* Specify the wirefilter expression used for device posture check. The API
|
|
235
|
+
* automatically formats and sanitizes expressions before storing them. To prevent
|
|
236
|
+
* Terraform state drift, use the formatted expression returned in the API
|
|
237
|
+
* response.
|
|
234
238
|
*/
|
|
235
239
|
device_posture?: string;
|
|
236
240
|
/**
|
|
237
|
-
*
|
|
238
|
-
* over the policy's `schedule` configuration, if any.
|
|
239
|
-
*
|
|
240
|
-
* This does not apply to HTTP or network policies.
|
|
241
|
+
* Defines the expiration time stamp and default duration of a DNS policy. Takes
|
|
242
|
+
* precedence over the policy's `schedule` configuration, if any. This does not
|
|
243
|
+
* apply to HTTP or network policies. Settable only for `dns` rules.
|
|
241
244
|
*/
|
|
242
245
|
expiration?: GatewayRule.Expiration | null;
|
|
243
246
|
/**
|
|
244
|
-
*
|
|
245
|
-
* formats and sanitizes
|
|
246
|
-
*
|
|
247
|
+
* Specify the wirefilter expression used for identity matching. The API
|
|
248
|
+
* automatically formats and sanitizes expressions before storing them. To prevent
|
|
249
|
+
* Terraform state drift, use the formatted expression returned in the API
|
|
250
|
+
* response.
|
|
247
251
|
*/
|
|
248
252
|
identity?: string;
|
|
249
253
|
/**
|
|
250
|
-
*
|
|
251
|
-
*/
|
|
252
|
-
not_sharable?: boolean;
|
|
253
|
-
/**
|
|
254
|
-
* The rule was shared via the Orgs API and cannot be edited by the current
|
|
255
|
-
* account.
|
|
254
|
+
* Indicate that this rule is shared via the Orgs API and read only.
|
|
256
255
|
*/
|
|
257
256
|
read_only?: boolean;
|
|
258
257
|
/**
|
|
259
|
-
*
|
|
258
|
+
* Set settings related to this rule. Each setting is only valid for specific rule
|
|
259
|
+
* types and can only be used with the appropriate selectors. If Terraform drift is
|
|
260
|
+
* observed in these setting values, verify that the setting is supported for the
|
|
261
|
+
* given rule type and that the API response reflects the requested value. If the
|
|
262
|
+
* API response returns sanitized or modified values that differ from the request,
|
|
263
|
+
* use the API-provided values in Terraform to ensure consistency.
|
|
260
264
|
*/
|
|
261
265
|
rule_settings?: RuleSetting;
|
|
262
266
|
/**
|
|
263
|
-
*
|
|
264
|
-
*
|
|
267
|
+
* Defines the schedule for activating DNS policies. Settable only for `dns` and
|
|
268
|
+
* `dns_resolver` rules.
|
|
265
269
|
*/
|
|
266
270
|
schedule?: Schedule | null;
|
|
267
271
|
/**
|
|
268
|
-
*
|
|
272
|
+
* Indicate that this rule is sharable via the Orgs API.
|
|
273
|
+
*/
|
|
274
|
+
sharable?: boolean;
|
|
275
|
+
/**
|
|
276
|
+
* Provide the account tag of the account that created the rule.
|
|
269
277
|
*/
|
|
270
278
|
source_account?: string;
|
|
271
279
|
updated_at?: string;
|
|
272
280
|
/**
|
|
273
|
-
* version number of the rule.
|
|
281
|
+
* Indicate the version number of the rule(read-only).
|
|
274
282
|
*/
|
|
275
283
|
version?: number;
|
|
276
284
|
/**
|
|
277
|
-
*
|
|
285
|
+
* Indicate a warning for a misconfigured rule, if any.
|
|
278
286
|
*/
|
|
279
287
|
warning_status?: string | null;
|
|
280
288
|
}
|
|
281
289
|
export declare namespace GatewayRule {
|
|
282
290
|
/**
|
|
283
|
-
*
|
|
284
|
-
* over the policy's `schedule` configuration, if any.
|
|
285
|
-
*
|
|
286
|
-
* This does not apply to HTTP or network policies.
|
|
291
|
+
* Defines the expiration time stamp and default duration of a DNS policy. Takes
|
|
292
|
+
* precedence over the policy's `schedule` configuration, if any. This does not
|
|
293
|
+
* apply to HTTP or network policies. Settable only for `dns` rules.
|
|
287
294
|
*/
|
|
288
295
|
interface Expiration {
|
|
289
296
|
/**
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
* Policies with an expiration do not consider the timezone of clients they are
|
|
297
|
-
* applied to, and expire "globally" at the point given by their `expires_at`
|
|
298
|
-
* value.
|
|
297
|
+
* Show the timestamp when the policy expires and stops applying. The value must
|
|
298
|
+
* follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets
|
|
299
|
+
* but converts them to the equivalent UTC+00:00 value and returns timestamps with
|
|
300
|
+
* a trailing Z. Expiration policies ignore client timezones and expire globally at
|
|
301
|
+
* the specified expires_at time.
|
|
299
302
|
*/
|
|
300
303
|
expires_at: string;
|
|
301
304
|
/**
|
|
302
|
-
*
|
|
305
|
+
* Defines the default duration a policy active in minutes. Must set in order to
|
|
303
306
|
* use the `reset_expiration` endpoint on this rule.
|
|
304
307
|
*/
|
|
305
308
|
duration?: number;
|
|
306
309
|
/**
|
|
307
|
-
*
|
|
310
|
+
* Indicates whether the policy is expired.
|
|
308
311
|
*/
|
|
309
312
|
expired?: boolean;
|
|
310
313
|
}
|
|
311
314
|
}
|
|
312
315
|
/**
|
|
313
|
-
*
|
|
316
|
+
* Set settings related to this rule. Each setting is only valid for specific rule
|
|
317
|
+
* types and can only be used with the appropriate selectors. If Terraform drift is
|
|
318
|
+
* observed in these setting values, verify that the setting is supported for the
|
|
319
|
+
* given rule type and that the API response reflects the requested value. If the
|
|
320
|
+
* API response returns sanitized or modified values that differ from the request,
|
|
321
|
+
* use the API-provided values in Terraform to ensure consistency.
|
|
314
322
|
*/
|
|
315
323
|
export interface RuleSetting {
|
|
316
324
|
/**
|
|
317
|
-
* Add custom headers to allowed requests
|
|
318
|
-
*
|
|
325
|
+
* Add custom headers to allowed requests as key-value pairs. Use header names as
|
|
326
|
+
* keys that map to arrays of header values. Settable only for `http` rules with
|
|
327
|
+
* the action set to `allow`.
|
|
319
328
|
*/
|
|
320
329
|
add_headers?: {
|
|
321
330
|
[key: string]: Array<string>;
|
|
322
331
|
} | null;
|
|
323
332
|
/**
|
|
324
|
-
* Set
|
|
333
|
+
* Set to enable MSP children to bypass this rule. Only parent MSP accounts can set
|
|
334
|
+
* this. this rule. Settable for all types of rules.
|
|
325
335
|
*/
|
|
326
336
|
allow_child_bypass?: boolean | null;
|
|
327
337
|
/**
|
|
328
|
-
*
|
|
338
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with
|
|
339
|
+
* `audit_ssh` action.
|
|
329
340
|
*/
|
|
330
341
|
audit_ssh?: RuleSetting.AuditSSH | null;
|
|
331
342
|
/**
|
|
332
|
-
* Configure
|
|
343
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the
|
|
344
|
+
* action set to `isolate`.
|
|
333
345
|
*/
|
|
334
346
|
biso_admin_controls?: RuleSetting.BISOAdminControls;
|
|
335
347
|
/**
|
|
336
|
-
*
|
|
337
|
-
* settings.
|
|
348
|
+
* Configure custom block page settings. If missing or null, use the account
|
|
349
|
+
* settings. Settable only for `http` rules with the action set to `block`.
|
|
338
350
|
*/
|
|
339
351
|
block_page?: RuleSetting.BlockPage | null;
|
|
340
352
|
/**
|
|
341
|
-
* Enable the custom block page.
|
|
353
|
+
* Enable the custom block page. Settable only for `dns` rules with action `block`.
|
|
342
354
|
*/
|
|
343
355
|
block_page_enabled?: boolean;
|
|
344
356
|
/**
|
|
345
|
-
*
|
|
346
|
-
* (if enabled).
|
|
357
|
+
* Explain why the rule blocks the request. The custom block page shows this text
|
|
358
|
+
* (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action
|
|
359
|
+
* set to `block`.
|
|
347
360
|
*/
|
|
348
361
|
block_reason?: string | null;
|
|
349
362
|
/**
|
|
350
|
-
* Set
|
|
363
|
+
* Set to enable MSP accounts to bypass their parent's rules. Only MSP child
|
|
364
|
+
* accounts can set this. Settable for all types of rules.
|
|
351
365
|
*/
|
|
352
366
|
bypass_parent_rule?: boolean | null;
|
|
353
367
|
/**
|
|
354
|
-
* Configure
|
|
368
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with
|
|
369
|
+
* the action set to `allow`.
|
|
355
370
|
*/
|
|
356
371
|
check_session?: RuleSetting.CheckSession | null;
|
|
357
372
|
/**
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
* valid when a rule's action
|
|
373
|
+
* Configure custom resolvers to route queries that match the resolver policy.
|
|
374
|
+
* Unused with 'resolve_dns_through_cloudflare' or 'resolve_dns_internally'
|
|
375
|
+
* settings. DNS queries get routed to the address closest to their origin. Only
|
|
376
|
+
* valid when a rule's action set to 'resolve'. Settable only for `dns_resolver`
|
|
377
|
+
* rules.
|
|
362
378
|
*/
|
|
363
379
|
dns_resolvers?: RuleSetting.DNSResolvers | null;
|
|
364
380
|
/**
|
|
365
381
|
* Configure how Gateway Proxy traffic egresses. You can enable this setting for
|
|
366
382
|
* rules with Egress actions and filters, or omit it to indicate local egress via
|
|
367
|
-
* WARP IPs.
|
|
383
|
+
* WARP IPs. Settable only for `egress` rules.
|
|
368
384
|
*/
|
|
369
385
|
egress?: RuleSetting.Egress | null;
|
|
370
386
|
/**
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
387
|
+
* Ignore category matches at CNAME domains in a response. When off, evaluate
|
|
388
|
+
* categories in this rule against all CNAME domain categories in the response.
|
|
389
|
+
* Settable only for `dns` and `dns_resolver` rules.
|
|
374
390
|
*/
|
|
375
391
|
ignore_cname_category_matches?: boolean;
|
|
376
392
|
/**
|
|
377
|
-
*
|
|
393
|
+
* Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE].
|
|
394
|
+
* Settable only for `dns` rules.
|
|
378
395
|
*/
|
|
379
396
|
insecure_disable_dnssec_validation?: boolean;
|
|
380
397
|
/**
|
|
381
|
-
*
|
|
382
|
-
*
|
|
398
|
+
* Enable IPs in DNS resolver category blocks. The system blocks only domain name
|
|
399
|
+
* categories unless you enable this setting. Settable only for `dns` and
|
|
400
|
+
* `dns_resolver` rules.
|
|
383
401
|
*/
|
|
384
402
|
ip_categories?: boolean;
|
|
385
403
|
/**
|
|
386
|
-
*
|
|
387
|
-
* indicator feeds
|
|
404
|
+
* Indicates whether to include IPs in DNS resolver indicator feed blocks. Default,
|
|
405
|
+
* indicator feeds block only domain names. Settable only for `dns` and
|
|
406
|
+
* `dns_resolver` rules.
|
|
388
407
|
*/
|
|
389
408
|
ip_indicator_feeds?: boolean;
|
|
390
409
|
/**
|
|
391
|
-
* Send matching traffic to the supplied destination IP address
|
|
410
|
+
* Send matching traffic to the supplied destination IP address and port. Settable
|
|
411
|
+
* only for `l4` rules with the action set to `l4_override`.
|
|
392
412
|
*/
|
|
393
413
|
l4override?: RuleSetting.L4override | null;
|
|
394
414
|
/**
|
|
395
|
-
* Configure a notification to display on the user's device when this rule
|
|
396
|
-
*
|
|
415
|
+
* Configure a notification to display on the user's device when this rule matched.
|
|
416
|
+
* Settable for all types of rules with the action set to `block`.
|
|
397
417
|
*/
|
|
398
418
|
notification_settings?: RuleSetting.NotificationSettings | null;
|
|
399
419
|
/**
|
|
400
|
-
*
|
|
420
|
+
* Defines a hostname for override, for the matching DNS queries. Settable only for
|
|
421
|
+
* `dns` rules with the action set to `override`.
|
|
401
422
|
*/
|
|
402
423
|
override_host?: string;
|
|
403
424
|
/**
|
|
404
|
-
*
|
|
425
|
+
* Defines a an IP or set of IPs for overriding matched DNS queries. Settable only
|
|
426
|
+
* for `dns` rules with the action set to `override`.
|
|
405
427
|
*/
|
|
406
428
|
override_ips?: Array<string> | null;
|
|
407
429
|
/**
|
|
408
|
-
* Configure DLP payload logging.
|
|
430
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
409
431
|
*/
|
|
410
432
|
payload_log?: RuleSetting.PayloadLog | null;
|
|
411
433
|
/**
|
|
412
|
-
*
|
|
434
|
+
* Configure settings that apply to quarantine rules. Settable only for `http`
|
|
435
|
+
* rules.
|
|
413
436
|
*/
|
|
414
437
|
quarantine?: RuleSetting.Quarantine | null;
|
|
415
438
|
/**
|
|
416
|
-
*
|
|
439
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action
|
|
440
|
+
* set to `redirect`.
|
|
417
441
|
*/
|
|
418
442
|
redirect?: RuleSetting.Redirect | null;
|
|
419
443
|
/**
|
|
420
444
|
* Configure to forward the query to the internal DNS service, passing the
|
|
421
|
-
* specified 'view_id' as input.
|
|
422
|
-
*
|
|
423
|
-
*
|
|
445
|
+
* specified 'view_id' as input. Not used when 'dns_resolvers' is specified or
|
|
446
|
+
* 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action set to
|
|
447
|
+
* 'resolve'. Settable only for `dns_resolver` rules.
|
|
424
448
|
*/
|
|
425
449
|
resolve_dns_internally?: RuleSetting.ResolveDNSInternally | null;
|
|
426
450
|
/**
|
|
427
451
|
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS
|
|
428
|
-
* resolver. Cannot
|
|
429
|
-
*
|
|
430
|
-
*
|
|
452
|
+
* resolver. Cannot set when 'dns_resolvers' specified or 'resolve_dns_internally'
|
|
453
|
+
* is set. Only valid when a rule's action set to 'resolve'. Settable only for
|
|
454
|
+
* `dns_resolver` rules.
|
|
431
455
|
*/
|
|
432
456
|
resolve_dns_through_cloudflare?: boolean | null;
|
|
433
457
|
/**
|
|
434
|
-
* Configure behavior when an upstream
|
|
458
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error
|
|
459
|
+
* occurs. Settable only for `http` rules with the action set to `allow`.
|
|
435
460
|
*/
|
|
436
461
|
untrusted_cert?: RuleSetting.UntrustedCERT | null;
|
|
437
462
|
}
|
|
438
463
|
export declare namespace RuleSetting {
|
|
439
464
|
/**
|
|
440
|
-
*
|
|
465
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with
|
|
466
|
+
* `audit_ssh` action.
|
|
441
467
|
*/
|
|
442
468
|
interface AuditSSH {
|
|
443
469
|
/**
|
|
444
|
-
* Enable
|
|
470
|
+
* Enable SSH command logging.
|
|
445
471
|
*/
|
|
446
472
|
command_logging?: boolean;
|
|
447
473
|
}
|
|
448
474
|
/**
|
|
449
|
-
* Configure
|
|
475
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the
|
|
476
|
+
* action set to `isolate`.
|
|
450
477
|
*/
|
|
451
478
|
interface BISOAdminControls {
|
|
452
479
|
/**
|
|
453
|
-
* Configure
|
|
454
|
-
*
|
|
455
|
-
*
|
|
480
|
+
* Configure copy behavior. If set to remote_only, users cannot copy isolated
|
|
481
|
+
* content from the remote browser to the local clipboard. If this field is absent,
|
|
482
|
+
* copying remains enabled. Applies only when version == "v2".
|
|
456
483
|
*/
|
|
457
484
|
copy?: 'enabled' | 'disabled' | 'remote_only';
|
|
458
485
|
/**
|
|
@@ -468,8 +495,8 @@ export declare namespace RuleSetting {
|
|
|
468
495
|
*/
|
|
469
496
|
dk?: boolean;
|
|
470
497
|
/**
|
|
471
|
-
* Configure
|
|
472
|
-
*
|
|
498
|
+
* Configure download behavior. When set to remote_only, users can view downloads
|
|
499
|
+
* but cannot save them. Applies only when version == "v2".
|
|
473
500
|
*/
|
|
474
501
|
download?: 'enabled' | 'disabled' | 'remote_only';
|
|
475
502
|
/**
|
|
@@ -481,65 +508,66 @@ export declare namespace RuleSetting {
|
|
|
481
508
|
*/
|
|
482
509
|
du?: boolean;
|
|
483
510
|
/**
|
|
484
|
-
* Configure
|
|
485
|
-
*
|
|
511
|
+
* Configure keyboard usage behavior. If this field is absent, keyboard usage
|
|
512
|
+
* remains enabled. Applies only when version == "v2".
|
|
486
513
|
*/
|
|
487
514
|
keyboard?: 'enabled' | 'disabled';
|
|
488
515
|
/**
|
|
489
|
-
* Configure
|
|
490
|
-
*
|
|
491
|
-
*
|
|
516
|
+
* Configure paste behavior. If set to remote_only, users cannot paste content from
|
|
517
|
+
* the local clipboard into isolated pages. If this field is absent, pasting
|
|
518
|
+
* remains enabled. Applies only when version == "v2".
|
|
492
519
|
*/
|
|
493
520
|
paste?: 'enabled' | 'disabled' | 'remote_only';
|
|
494
521
|
/**
|
|
495
|
-
* Configure
|
|
496
|
-
*
|
|
522
|
+
* Configure print behavior. Default, Printing is enabled. Applies only when
|
|
523
|
+
* version == "v2".
|
|
497
524
|
*/
|
|
498
525
|
printing?: 'enabled' | 'disabled';
|
|
499
526
|
/**
|
|
500
|
-
* Configure
|
|
501
|
-
*
|
|
527
|
+
* Configure upload behavior. If this field is absent, uploading remains enabled.
|
|
528
|
+
* Applies only when version == "v2".
|
|
502
529
|
*/
|
|
503
530
|
upload?: 'enabled' | 'disabled';
|
|
504
531
|
/**
|
|
505
|
-
*
|
|
532
|
+
* Indicate which version of the browser isolation controls should apply.
|
|
506
533
|
*/
|
|
507
534
|
version?: 'v1' | 'v2';
|
|
508
535
|
}
|
|
509
536
|
/**
|
|
510
|
-
*
|
|
511
|
-
* settings.
|
|
537
|
+
* Configure custom block page settings. If missing or null, use the account
|
|
538
|
+
* settings. Settable only for `http` rules with the action set to `block`.
|
|
512
539
|
*/
|
|
513
540
|
interface BlockPage {
|
|
514
541
|
/**
|
|
515
|
-
* URI to which the user
|
|
542
|
+
* Specify the URI to which the user is redirected.
|
|
516
543
|
*/
|
|
517
544
|
target_uri: string;
|
|
518
545
|
/**
|
|
519
|
-
*
|
|
546
|
+
* Specify whether to pass the context information as query parameters.
|
|
520
547
|
*/
|
|
521
548
|
include_context?: boolean;
|
|
522
549
|
}
|
|
523
550
|
/**
|
|
524
|
-
* Configure
|
|
551
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with
|
|
552
|
+
* the action set to `allow`.
|
|
525
553
|
*/
|
|
526
554
|
interface CheckSession {
|
|
527
555
|
/**
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
* version that may differ from your input and cause Terraform state drift.
|
|
556
|
+
* Sets the required session freshness threshold. The API returns a normalized
|
|
557
|
+
* version of this value.
|
|
531
558
|
*/
|
|
532
559
|
duration?: string;
|
|
533
560
|
/**
|
|
534
|
-
*
|
|
561
|
+
* Enable session enforcement.
|
|
535
562
|
*/
|
|
536
563
|
enforce?: boolean;
|
|
537
564
|
}
|
|
538
565
|
/**
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
* valid when a rule's action
|
|
566
|
+
* Configure custom resolvers to route queries that match the resolver policy.
|
|
567
|
+
* Unused with 'resolve_dns_through_cloudflare' or 'resolve_dns_internally'
|
|
568
|
+
* settings. DNS queries get routed to the address closest to their origin. Only
|
|
569
|
+
* valid when a rule's action set to 'resolve'. Settable only for `dns_resolver`
|
|
570
|
+
* rules.
|
|
543
571
|
*/
|
|
544
572
|
interface DNSResolvers {
|
|
545
573
|
ipv4?: Array<RulesAPI.DNSResolverSettingsV4>;
|
|
@@ -548,48 +576,48 @@ export declare namespace RuleSetting {
|
|
|
548
576
|
/**
|
|
549
577
|
* Configure how Gateway Proxy traffic egresses. You can enable this setting for
|
|
550
578
|
* rules with Egress actions and filters, or omit it to indicate local egress via
|
|
551
|
-
* WARP IPs.
|
|
579
|
+
* WARP IPs. Settable only for `egress` rules.
|
|
552
580
|
*/
|
|
553
581
|
interface Egress {
|
|
554
582
|
/**
|
|
555
|
-
*
|
|
583
|
+
* Specify the IPv4 address to use for egress.
|
|
556
584
|
*/
|
|
557
585
|
ipv4?: string;
|
|
558
586
|
/**
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
* WARP IPs.
|
|
587
|
+
* Specify the fallback IPv4 address to use for egress when the primary IPv4 fails.
|
|
588
|
+
* Set '0.0.0.0' to indicate local egress via WARP IPs.
|
|
562
589
|
*/
|
|
563
590
|
ipv4_fallback?: string;
|
|
564
591
|
/**
|
|
565
|
-
*
|
|
592
|
+
* Specify the IPv6 range to use for egress.
|
|
566
593
|
*/
|
|
567
594
|
ipv6?: string;
|
|
568
595
|
}
|
|
569
596
|
/**
|
|
570
|
-
* Send matching traffic to the supplied destination IP address
|
|
597
|
+
* Send matching traffic to the supplied destination IP address and port. Settable
|
|
598
|
+
* only for `l4` rules with the action set to `l4_override`.
|
|
571
599
|
*/
|
|
572
600
|
interface L4override {
|
|
573
601
|
/**
|
|
574
|
-
* IPv4 or IPv6 address.
|
|
602
|
+
* Defines the IPv4 or IPv6 address.
|
|
575
603
|
*/
|
|
576
604
|
ip?: string;
|
|
577
605
|
/**
|
|
578
|
-
*
|
|
606
|
+
* Defines a port number to use for TCP/UDP overrides.
|
|
579
607
|
*/
|
|
580
608
|
port?: number;
|
|
581
609
|
}
|
|
582
610
|
/**
|
|
583
|
-
* Configure a notification to display on the user's device when this rule
|
|
584
|
-
*
|
|
611
|
+
* Configure a notification to display on the user's device when this rule matched.
|
|
612
|
+
* Settable for all types of rules with the action set to `block`.
|
|
585
613
|
*/
|
|
586
614
|
interface NotificationSettings {
|
|
587
615
|
/**
|
|
588
|
-
*
|
|
616
|
+
* Enable notification.
|
|
589
617
|
*/
|
|
590
618
|
enabled?: boolean;
|
|
591
619
|
/**
|
|
592
|
-
*
|
|
620
|
+
* Indicates whether to pass the context information as query parameters.
|
|
593
621
|
*/
|
|
594
622
|
include_context?: boolean;
|
|
595
623
|
/**
|
|
@@ -597,220 +625,247 @@ export declare namespace RuleSetting {
|
|
|
597
625
|
*/
|
|
598
626
|
msg?: string;
|
|
599
627
|
/**
|
|
600
|
-
*
|
|
601
|
-
* notification
|
|
628
|
+
* Defines an optional URL to direct users to additional information. If unset, the
|
|
629
|
+
* notification opens a block page.
|
|
602
630
|
*/
|
|
603
631
|
support_url?: string;
|
|
604
632
|
}
|
|
605
633
|
/**
|
|
606
|
-
* Configure DLP payload logging.
|
|
634
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
607
635
|
*/
|
|
608
636
|
interface PayloadLog {
|
|
609
637
|
/**
|
|
610
|
-
*
|
|
638
|
+
* Enable DLP payload logging for this rule.
|
|
611
639
|
*/
|
|
612
640
|
enabled?: boolean;
|
|
613
641
|
}
|
|
614
642
|
/**
|
|
615
|
-
*
|
|
643
|
+
* Configure settings that apply to quarantine rules. Settable only for `http`
|
|
644
|
+
* rules.
|
|
616
645
|
*/
|
|
617
646
|
interface Quarantine {
|
|
618
647
|
/**
|
|
619
|
-
*
|
|
648
|
+
* Specify the types of files to sandbox.
|
|
620
649
|
*/
|
|
621
650
|
file_types?: Array<'exe' | 'pdf' | 'doc' | 'docm' | 'docx' | 'rtf' | 'ppt' | 'pptx' | 'xls' | 'xlsm' | 'xlsx' | 'zip' | 'rar'>;
|
|
622
651
|
}
|
|
623
652
|
/**
|
|
624
|
-
*
|
|
653
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action
|
|
654
|
+
* set to `redirect`.
|
|
625
655
|
*/
|
|
626
656
|
interface Redirect {
|
|
627
657
|
/**
|
|
628
|
-
* URI to which the user
|
|
658
|
+
* Specify the URI to which the user is redirected.
|
|
629
659
|
*/
|
|
630
660
|
target_uri: string;
|
|
631
661
|
/**
|
|
632
|
-
*
|
|
662
|
+
* Specify whether to pass the context information as query parameters.
|
|
633
663
|
*/
|
|
634
664
|
include_context?: boolean;
|
|
635
665
|
/**
|
|
636
|
-
*
|
|
637
|
-
*
|
|
666
|
+
* Specify whether to append the path and query parameters from the original
|
|
667
|
+
* request to target_uri.
|
|
638
668
|
*/
|
|
639
669
|
preserve_path_and_query?: boolean;
|
|
640
670
|
}
|
|
641
671
|
/**
|
|
642
672
|
* Configure to forward the query to the internal DNS service, passing the
|
|
643
|
-
* specified 'view_id' as input.
|
|
644
|
-
*
|
|
645
|
-
*
|
|
673
|
+
* specified 'view_id' as input. Not used when 'dns_resolvers' is specified or
|
|
674
|
+
* 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action set to
|
|
675
|
+
* 'resolve'. Settable only for `dns_resolver` rules.
|
|
646
676
|
*/
|
|
647
677
|
interface ResolveDNSInternally {
|
|
648
678
|
/**
|
|
649
|
-
*
|
|
650
|
-
* from 'NOERROR' or when the response data only
|
|
651
|
-
* 'AAAA' queries.
|
|
679
|
+
* Specify the fallback behavior to apply when the internal DNS response code
|
|
680
|
+
* differs from 'NOERROR' or when the response data contains only CNAME records for
|
|
681
|
+
* 'A' or 'AAAA' queries.
|
|
652
682
|
*/
|
|
653
683
|
fallback?: 'none' | 'public_dns';
|
|
654
684
|
/**
|
|
655
|
-
*
|
|
685
|
+
* Specify the internal DNS view identifier to pass to the internal DNS service.
|
|
656
686
|
*/
|
|
657
687
|
view_id?: string;
|
|
658
688
|
}
|
|
659
689
|
/**
|
|
660
|
-
* Configure behavior when an upstream
|
|
690
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error
|
|
691
|
+
* occurs. Settable only for `http` rules with the action set to `allow`.
|
|
661
692
|
*/
|
|
662
693
|
interface UntrustedCERT {
|
|
663
694
|
/**
|
|
664
|
-
*
|
|
665
|
-
*
|
|
695
|
+
* Defines the action performed when an untrusted certificate seen. The default
|
|
696
|
+
* action an error with HTTP code 526.
|
|
666
697
|
*/
|
|
667
698
|
action?: 'pass_through' | 'block' | 'error';
|
|
668
699
|
}
|
|
669
700
|
}
|
|
670
701
|
/**
|
|
671
|
-
*
|
|
702
|
+
* Set settings related to this rule. Each setting is only valid for specific rule
|
|
703
|
+
* types and can only be used with the appropriate selectors. If Terraform drift is
|
|
704
|
+
* observed in these setting values, verify that the setting is supported for the
|
|
705
|
+
* given rule type and that the API response reflects the requested value. If the
|
|
706
|
+
* API response returns sanitized or modified values that differ from the request,
|
|
707
|
+
* use the API-provided values in Terraform to ensure consistency.
|
|
672
708
|
*/
|
|
673
709
|
export interface RuleSettingParam {
|
|
674
710
|
/**
|
|
675
|
-
* Add custom headers to allowed requests
|
|
676
|
-
*
|
|
711
|
+
* Add custom headers to allowed requests as key-value pairs. Use header names as
|
|
712
|
+
* keys that map to arrays of header values. Settable only for `http` rules with
|
|
713
|
+
* the action set to `allow`.
|
|
677
714
|
*/
|
|
678
715
|
add_headers?: {
|
|
679
716
|
[key: string]: Array<string>;
|
|
680
717
|
} | null;
|
|
681
718
|
/**
|
|
682
|
-
* Set
|
|
719
|
+
* Set to enable MSP children to bypass this rule. Only parent MSP accounts can set
|
|
720
|
+
* this. this rule. Settable for all types of rules.
|
|
683
721
|
*/
|
|
684
722
|
allow_child_bypass?: boolean | null;
|
|
685
723
|
/**
|
|
686
|
-
*
|
|
724
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with
|
|
725
|
+
* `audit_ssh` action.
|
|
687
726
|
*/
|
|
688
727
|
audit_ssh?: RuleSettingParam.AuditSSH | null;
|
|
689
728
|
/**
|
|
690
|
-
* Configure
|
|
729
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the
|
|
730
|
+
* action set to `isolate`.
|
|
691
731
|
*/
|
|
692
732
|
biso_admin_controls?: RuleSettingParam.BISOAdminControls;
|
|
693
733
|
/**
|
|
694
|
-
*
|
|
695
|
-
* settings.
|
|
734
|
+
* Configure custom block page settings. If missing or null, use the account
|
|
735
|
+
* settings. Settable only for `http` rules with the action set to `block`.
|
|
696
736
|
*/
|
|
697
737
|
block_page?: RuleSettingParam.BlockPage | null;
|
|
698
738
|
/**
|
|
699
|
-
* Enable the custom block page.
|
|
739
|
+
* Enable the custom block page. Settable only for `dns` rules with action `block`.
|
|
700
740
|
*/
|
|
701
741
|
block_page_enabled?: boolean;
|
|
702
742
|
/**
|
|
703
|
-
*
|
|
704
|
-
* (if enabled).
|
|
743
|
+
* Explain why the rule blocks the request. The custom block page shows this text
|
|
744
|
+
* (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action
|
|
745
|
+
* set to `block`.
|
|
705
746
|
*/
|
|
706
747
|
block_reason?: string | null;
|
|
707
748
|
/**
|
|
708
|
-
* Set
|
|
749
|
+
* Set to enable MSP accounts to bypass their parent's rules. Only MSP child
|
|
750
|
+
* accounts can set this. Settable for all types of rules.
|
|
709
751
|
*/
|
|
710
752
|
bypass_parent_rule?: boolean | null;
|
|
711
753
|
/**
|
|
712
|
-
* Configure
|
|
754
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with
|
|
755
|
+
* the action set to `allow`.
|
|
713
756
|
*/
|
|
714
757
|
check_session?: RuleSettingParam.CheckSession | null;
|
|
715
758
|
/**
|
|
716
|
-
*
|
|
717
|
-
*
|
|
718
|
-
*
|
|
719
|
-
* valid when a rule's action
|
|
759
|
+
* Configure custom resolvers to route queries that match the resolver policy.
|
|
760
|
+
* Unused with 'resolve_dns_through_cloudflare' or 'resolve_dns_internally'
|
|
761
|
+
* settings. DNS queries get routed to the address closest to their origin. Only
|
|
762
|
+
* valid when a rule's action set to 'resolve'. Settable only for `dns_resolver`
|
|
763
|
+
* rules.
|
|
720
764
|
*/
|
|
721
765
|
dns_resolvers?: RuleSettingParam.DNSResolvers | null;
|
|
722
766
|
/**
|
|
723
767
|
* Configure how Gateway Proxy traffic egresses. You can enable this setting for
|
|
724
768
|
* rules with Egress actions and filters, or omit it to indicate local egress via
|
|
725
|
-
* WARP IPs.
|
|
769
|
+
* WARP IPs. Settable only for `egress` rules.
|
|
726
770
|
*/
|
|
727
771
|
egress?: RuleSettingParam.Egress | null;
|
|
728
772
|
/**
|
|
729
|
-
*
|
|
730
|
-
*
|
|
731
|
-
*
|
|
773
|
+
* Ignore category matches at CNAME domains in a response. When off, evaluate
|
|
774
|
+
* categories in this rule against all CNAME domain categories in the response.
|
|
775
|
+
* Settable only for `dns` and `dns_resolver` rules.
|
|
732
776
|
*/
|
|
733
777
|
ignore_cname_category_matches?: boolean;
|
|
734
778
|
/**
|
|
735
|
-
*
|
|
779
|
+
* Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE].
|
|
780
|
+
* Settable only for `dns` rules.
|
|
736
781
|
*/
|
|
737
782
|
insecure_disable_dnssec_validation?: boolean;
|
|
738
783
|
/**
|
|
739
|
-
*
|
|
740
|
-
*
|
|
784
|
+
* Enable IPs in DNS resolver category blocks. The system blocks only domain name
|
|
785
|
+
* categories unless you enable this setting. Settable only for `dns` and
|
|
786
|
+
* `dns_resolver` rules.
|
|
741
787
|
*/
|
|
742
788
|
ip_categories?: boolean;
|
|
743
789
|
/**
|
|
744
|
-
*
|
|
745
|
-
* indicator feeds
|
|
790
|
+
* Indicates whether to include IPs in DNS resolver indicator feed blocks. Default,
|
|
791
|
+
* indicator feeds block only domain names. Settable only for `dns` and
|
|
792
|
+
* `dns_resolver` rules.
|
|
746
793
|
*/
|
|
747
794
|
ip_indicator_feeds?: boolean;
|
|
748
795
|
/**
|
|
749
|
-
* Send matching traffic to the supplied destination IP address
|
|
796
|
+
* Send matching traffic to the supplied destination IP address and port. Settable
|
|
797
|
+
* only for `l4` rules with the action set to `l4_override`.
|
|
750
798
|
*/
|
|
751
799
|
l4override?: RuleSettingParam.L4override | null;
|
|
752
800
|
/**
|
|
753
|
-
* Configure a notification to display on the user's device when this rule
|
|
754
|
-
*
|
|
801
|
+
* Configure a notification to display on the user's device when this rule matched.
|
|
802
|
+
* Settable for all types of rules with the action set to `block`.
|
|
755
803
|
*/
|
|
756
804
|
notification_settings?: RuleSettingParam.NotificationSettings | null;
|
|
757
805
|
/**
|
|
758
|
-
*
|
|
806
|
+
* Defines a hostname for override, for the matching DNS queries. Settable only for
|
|
807
|
+
* `dns` rules with the action set to `override`.
|
|
759
808
|
*/
|
|
760
809
|
override_host?: string;
|
|
761
810
|
/**
|
|
762
|
-
*
|
|
811
|
+
* Defines a an IP or set of IPs for overriding matched DNS queries. Settable only
|
|
812
|
+
* for `dns` rules with the action set to `override`.
|
|
763
813
|
*/
|
|
764
814
|
override_ips?: Array<string> | null;
|
|
765
815
|
/**
|
|
766
|
-
* Configure DLP payload logging.
|
|
816
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
767
817
|
*/
|
|
768
818
|
payload_log?: RuleSettingParam.PayloadLog | null;
|
|
769
819
|
/**
|
|
770
|
-
*
|
|
820
|
+
* Configure settings that apply to quarantine rules. Settable only for `http`
|
|
821
|
+
* rules.
|
|
771
822
|
*/
|
|
772
823
|
quarantine?: RuleSettingParam.Quarantine | null;
|
|
773
824
|
/**
|
|
774
|
-
*
|
|
825
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action
|
|
826
|
+
* set to `redirect`.
|
|
775
827
|
*/
|
|
776
828
|
redirect?: RuleSettingParam.Redirect | null;
|
|
777
829
|
/**
|
|
778
830
|
* Configure to forward the query to the internal DNS service, passing the
|
|
779
|
-
* specified 'view_id' as input.
|
|
780
|
-
*
|
|
781
|
-
*
|
|
831
|
+
* specified 'view_id' as input. Not used when 'dns_resolvers' is specified or
|
|
832
|
+
* 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action set to
|
|
833
|
+
* 'resolve'. Settable only for `dns_resolver` rules.
|
|
782
834
|
*/
|
|
783
835
|
resolve_dns_internally?: RuleSettingParam.ResolveDNSInternally | null;
|
|
784
836
|
/**
|
|
785
837
|
* Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS
|
|
786
|
-
* resolver. Cannot
|
|
787
|
-
*
|
|
788
|
-
*
|
|
838
|
+
* resolver. Cannot set when 'dns_resolvers' specified or 'resolve_dns_internally'
|
|
839
|
+
* is set. Only valid when a rule's action set to 'resolve'. Settable only for
|
|
840
|
+
* `dns_resolver` rules.
|
|
789
841
|
*/
|
|
790
842
|
resolve_dns_through_cloudflare?: boolean | null;
|
|
791
843
|
/**
|
|
792
|
-
* Configure behavior when an upstream
|
|
844
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error
|
|
845
|
+
* occurs. Settable only for `http` rules with the action set to `allow`.
|
|
793
846
|
*/
|
|
794
847
|
untrusted_cert?: RuleSettingParam.UntrustedCERT | null;
|
|
795
848
|
}
|
|
796
849
|
export declare namespace RuleSettingParam {
|
|
797
850
|
/**
|
|
798
|
-
*
|
|
851
|
+
* Define the settings for the Audit SSH action. Settable only for `l4` rules with
|
|
852
|
+
* `audit_ssh` action.
|
|
799
853
|
*/
|
|
800
854
|
interface AuditSSH {
|
|
801
855
|
/**
|
|
802
|
-
* Enable
|
|
856
|
+
* Enable SSH command logging.
|
|
803
857
|
*/
|
|
804
858
|
command_logging?: boolean;
|
|
805
859
|
}
|
|
806
860
|
/**
|
|
807
|
-
* Configure
|
|
861
|
+
* Configure browser isolation behavior. Settable only for `http` rules with the
|
|
862
|
+
* action set to `isolate`.
|
|
808
863
|
*/
|
|
809
864
|
interface BISOAdminControls {
|
|
810
865
|
/**
|
|
811
|
-
* Configure
|
|
812
|
-
*
|
|
813
|
-
*
|
|
866
|
+
* Configure copy behavior. If set to remote_only, users cannot copy isolated
|
|
867
|
+
* content from the remote browser to the local clipboard. If this field is absent,
|
|
868
|
+
* copying remains enabled. Applies only when version == "v2".
|
|
814
869
|
*/
|
|
815
870
|
copy?: 'enabled' | 'disabled' | 'remote_only';
|
|
816
871
|
/**
|
|
@@ -826,8 +881,8 @@ export declare namespace RuleSettingParam {
|
|
|
826
881
|
*/
|
|
827
882
|
dk?: boolean;
|
|
828
883
|
/**
|
|
829
|
-
* Configure
|
|
830
|
-
*
|
|
884
|
+
* Configure download behavior. When set to remote_only, users can view downloads
|
|
885
|
+
* but cannot save them. Applies only when version == "v2".
|
|
831
886
|
*/
|
|
832
887
|
download?: 'enabled' | 'disabled' | 'remote_only';
|
|
833
888
|
/**
|
|
@@ -839,65 +894,66 @@ export declare namespace RuleSettingParam {
|
|
|
839
894
|
*/
|
|
840
895
|
du?: boolean;
|
|
841
896
|
/**
|
|
842
|
-
* Configure
|
|
843
|
-
*
|
|
897
|
+
* Configure keyboard usage behavior. If this field is absent, keyboard usage
|
|
898
|
+
* remains enabled. Applies only when version == "v2".
|
|
844
899
|
*/
|
|
845
900
|
keyboard?: 'enabled' | 'disabled';
|
|
846
901
|
/**
|
|
847
|
-
* Configure
|
|
848
|
-
*
|
|
849
|
-
*
|
|
902
|
+
* Configure paste behavior. If set to remote_only, users cannot paste content from
|
|
903
|
+
* the local clipboard into isolated pages. If this field is absent, pasting
|
|
904
|
+
* remains enabled. Applies only when version == "v2".
|
|
850
905
|
*/
|
|
851
906
|
paste?: 'enabled' | 'disabled' | 'remote_only';
|
|
852
907
|
/**
|
|
853
|
-
* Configure
|
|
854
|
-
*
|
|
908
|
+
* Configure print behavior. Default, Printing is enabled. Applies only when
|
|
909
|
+
* version == "v2".
|
|
855
910
|
*/
|
|
856
911
|
printing?: 'enabled' | 'disabled';
|
|
857
912
|
/**
|
|
858
|
-
* Configure
|
|
859
|
-
*
|
|
913
|
+
* Configure upload behavior. If this field is absent, uploading remains enabled.
|
|
914
|
+
* Applies only when version == "v2".
|
|
860
915
|
*/
|
|
861
916
|
upload?: 'enabled' | 'disabled';
|
|
862
917
|
/**
|
|
863
|
-
*
|
|
918
|
+
* Indicate which version of the browser isolation controls should apply.
|
|
864
919
|
*/
|
|
865
920
|
version?: 'v1' | 'v2';
|
|
866
921
|
}
|
|
867
922
|
/**
|
|
868
|
-
*
|
|
869
|
-
* settings.
|
|
923
|
+
* Configure custom block page settings. If missing or null, use the account
|
|
924
|
+
* settings. Settable only for `http` rules with the action set to `block`.
|
|
870
925
|
*/
|
|
871
926
|
interface BlockPage {
|
|
872
927
|
/**
|
|
873
|
-
* URI to which the user
|
|
928
|
+
* Specify the URI to which the user is redirected.
|
|
874
929
|
*/
|
|
875
930
|
target_uri: string;
|
|
876
931
|
/**
|
|
877
|
-
*
|
|
932
|
+
* Specify whether to pass the context information as query parameters.
|
|
878
933
|
*/
|
|
879
934
|
include_context?: boolean;
|
|
880
935
|
}
|
|
881
936
|
/**
|
|
882
|
-
* Configure
|
|
937
|
+
* Configure session check behavior. Settable only for `l4` and `http` rules with
|
|
938
|
+
* the action set to `allow`.
|
|
883
939
|
*/
|
|
884
940
|
interface CheckSession {
|
|
885
941
|
/**
|
|
886
|
-
*
|
|
887
|
-
*
|
|
888
|
-
* version that may differ from your input and cause Terraform state drift.
|
|
942
|
+
* Sets the required session freshness threshold. The API returns a normalized
|
|
943
|
+
* version of this value.
|
|
889
944
|
*/
|
|
890
945
|
duration?: string;
|
|
891
946
|
/**
|
|
892
|
-
*
|
|
947
|
+
* Enable session enforcement.
|
|
893
948
|
*/
|
|
894
949
|
enforce?: boolean;
|
|
895
950
|
}
|
|
896
951
|
/**
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
* valid when a rule's action
|
|
952
|
+
* Configure custom resolvers to route queries that match the resolver policy.
|
|
953
|
+
* Unused with 'resolve_dns_through_cloudflare' or 'resolve_dns_internally'
|
|
954
|
+
* settings. DNS queries get routed to the address closest to their origin. Only
|
|
955
|
+
* valid when a rule's action set to 'resolve'. Settable only for `dns_resolver`
|
|
956
|
+
* rules.
|
|
901
957
|
*/
|
|
902
958
|
interface DNSResolvers {
|
|
903
959
|
ipv4?: Array<RulesAPI.DNSResolverSettingsV4Param>;
|
|
@@ -906,48 +962,48 @@ export declare namespace RuleSettingParam {
|
|
|
906
962
|
/**
|
|
907
963
|
* Configure how Gateway Proxy traffic egresses. You can enable this setting for
|
|
908
964
|
* rules with Egress actions and filters, or omit it to indicate local egress via
|
|
909
|
-
* WARP IPs.
|
|
965
|
+
* WARP IPs. Settable only for `egress` rules.
|
|
910
966
|
*/
|
|
911
967
|
interface Egress {
|
|
912
968
|
/**
|
|
913
|
-
*
|
|
969
|
+
* Specify the IPv4 address to use for egress.
|
|
914
970
|
*/
|
|
915
971
|
ipv4?: string;
|
|
916
972
|
/**
|
|
917
|
-
*
|
|
918
|
-
*
|
|
919
|
-
* WARP IPs.
|
|
973
|
+
* Specify the fallback IPv4 address to use for egress when the primary IPv4 fails.
|
|
974
|
+
* Set '0.0.0.0' to indicate local egress via WARP IPs.
|
|
920
975
|
*/
|
|
921
976
|
ipv4_fallback?: string;
|
|
922
977
|
/**
|
|
923
|
-
*
|
|
978
|
+
* Specify the IPv6 range to use for egress.
|
|
924
979
|
*/
|
|
925
980
|
ipv6?: string;
|
|
926
981
|
}
|
|
927
982
|
/**
|
|
928
|
-
* Send matching traffic to the supplied destination IP address
|
|
983
|
+
* Send matching traffic to the supplied destination IP address and port. Settable
|
|
984
|
+
* only for `l4` rules with the action set to `l4_override`.
|
|
929
985
|
*/
|
|
930
986
|
interface L4override {
|
|
931
987
|
/**
|
|
932
|
-
* IPv4 or IPv6 address.
|
|
988
|
+
* Defines the IPv4 or IPv6 address.
|
|
933
989
|
*/
|
|
934
990
|
ip?: string;
|
|
935
991
|
/**
|
|
936
|
-
*
|
|
992
|
+
* Defines a port number to use for TCP/UDP overrides.
|
|
937
993
|
*/
|
|
938
994
|
port?: number;
|
|
939
995
|
}
|
|
940
996
|
/**
|
|
941
|
-
* Configure a notification to display on the user's device when this rule
|
|
942
|
-
*
|
|
997
|
+
* Configure a notification to display on the user's device when this rule matched.
|
|
998
|
+
* Settable for all types of rules with the action set to `block`.
|
|
943
999
|
*/
|
|
944
1000
|
interface NotificationSettings {
|
|
945
1001
|
/**
|
|
946
|
-
*
|
|
1002
|
+
* Enable notification.
|
|
947
1003
|
*/
|
|
948
1004
|
enabled?: boolean;
|
|
949
1005
|
/**
|
|
950
|
-
*
|
|
1006
|
+
* Indicates whether to pass the context information as query parameters.
|
|
951
1007
|
*/
|
|
952
1008
|
include_context?: boolean;
|
|
953
1009
|
/**
|
|
@@ -955,189 +1011,204 @@ export declare namespace RuleSettingParam {
|
|
|
955
1011
|
*/
|
|
956
1012
|
msg?: string;
|
|
957
1013
|
/**
|
|
958
|
-
*
|
|
959
|
-
* notification
|
|
1014
|
+
* Defines an optional URL to direct users to additional information. If unset, the
|
|
1015
|
+
* notification opens a block page.
|
|
960
1016
|
*/
|
|
961
1017
|
support_url?: string;
|
|
962
1018
|
}
|
|
963
1019
|
/**
|
|
964
|
-
* Configure DLP payload logging.
|
|
1020
|
+
* Configure DLP payload logging. Settable only for `http` rules.
|
|
965
1021
|
*/
|
|
966
1022
|
interface PayloadLog {
|
|
967
1023
|
/**
|
|
968
|
-
*
|
|
1024
|
+
* Enable DLP payload logging for this rule.
|
|
969
1025
|
*/
|
|
970
1026
|
enabled?: boolean;
|
|
971
1027
|
}
|
|
972
1028
|
/**
|
|
973
|
-
*
|
|
1029
|
+
* Configure settings that apply to quarantine rules. Settable only for `http`
|
|
1030
|
+
* rules.
|
|
974
1031
|
*/
|
|
975
1032
|
interface Quarantine {
|
|
976
1033
|
/**
|
|
977
|
-
*
|
|
1034
|
+
* Specify the types of files to sandbox.
|
|
978
1035
|
*/
|
|
979
1036
|
file_types?: Array<'exe' | 'pdf' | 'doc' | 'docm' | 'docx' | 'rtf' | 'ppt' | 'pptx' | 'xls' | 'xlsm' | 'xlsx' | 'zip' | 'rar'>;
|
|
980
1037
|
}
|
|
981
1038
|
/**
|
|
982
|
-
*
|
|
1039
|
+
* Apply settings to redirect rules. Settable only for `http` rules with the action
|
|
1040
|
+
* set to `redirect`.
|
|
983
1041
|
*/
|
|
984
1042
|
interface Redirect {
|
|
985
1043
|
/**
|
|
986
|
-
* URI to which the user
|
|
1044
|
+
* Specify the URI to which the user is redirected.
|
|
987
1045
|
*/
|
|
988
1046
|
target_uri: string;
|
|
989
1047
|
/**
|
|
990
|
-
*
|
|
1048
|
+
* Specify whether to pass the context information as query parameters.
|
|
991
1049
|
*/
|
|
992
1050
|
include_context?: boolean;
|
|
993
1051
|
/**
|
|
994
|
-
*
|
|
995
|
-
*
|
|
1052
|
+
* Specify whether to append the path and query parameters from the original
|
|
1053
|
+
* request to target_uri.
|
|
996
1054
|
*/
|
|
997
1055
|
preserve_path_and_query?: boolean;
|
|
998
1056
|
}
|
|
999
1057
|
/**
|
|
1000
1058
|
* Configure to forward the query to the internal DNS service, passing the
|
|
1001
|
-
* specified 'view_id' as input.
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
1059
|
+
* specified 'view_id' as input. Not used when 'dns_resolvers' is specified or
|
|
1060
|
+
* 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action set to
|
|
1061
|
+
* 'resolve'. Settable only for `dns_resolver` rules.
|
|
1004
1062
|
*/
|
|
1005
1063
|
interface ResolveDNSInternally {
|
|
1006
1064
|
/**
|
|
1007
|
-
*
|
|
1008
|
-
* from 'NOERROR' or when the response data only
|
|
1009
|
-
* 'AAAA' queries.
|
|
1065
|
+
* Specify the fallback behavior to apply when the internal DNS response code
|
|
1066
|
+
* differs from 'NOERROR' or when the response data contains only CNAME records for
|
|
1067
|
+
* 'A' or 'AAAA' queries.
|
|
1010
1068
|
*/
|
|
1011
1069
|
fallback?: 'none' | 'public_dns';
|
|
1012
1070
|
/**
|
|
1013
|
-
*
|
|
1071
|
+
* Specify the internal DNS view identifier to pass to the internal DNS service.
|
|
1014
1072
|
*/
|
|
1015
1073
|
view_id?: string;
|
|
1016
1074
|
}
|
|
1017
1075
|
/**
|
|
1018
|
-
* Configure behavior when an upstream
|
|
1076
|
+
* Configure behavior when an upstream certificate is invalid or an SSL error
|
|
1077
|
+
* occurs. Settable only for `http` rules with the action set to `allow`.
|
|
1019
1078
|
*/
|
|
1020
1079
|
interface UntrustedCERT {
|
|
1021
1080
|
/**
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1081
|
+
* Defines the action performed when an untrusted certificate seen. The default
|
|
1082
|
+
* action an error with HTTP code 526.
|
|
1024
1083
|
*/
|
|
1025
1084
|
action?: 'pass_through' | 'block' | 'error';
|
|
1026
1085
|
}
|
|
1027
1086
|
}
|
|
1028
1087
|
/**
|
|
1029
|
-
*
|
|
1030
|
-
*
|
|
1088
|
+
* Defines the schedule for activating DNS policies. Settable only for `dns` and
|
|
1089
|
+
* `dns_resolver` rules.
|
|
1031
1090
|
*/
|
|
1032
1091
|
export interface Schedule {
|
|
1033
1092
|
/**
|
|
1034
|
-
*
|
|
1035
|
-
* from 00:00-24:00. If this parameter
|
|
1036
|
-
* Fridays.
|
|
1093
|
+
* Specify the time intervals when the rule is active on Fridays, in the increasing
|
|
1094
|
+
* order from 00:00-24:00. If this parameter omitted, the rule is deactivated on
|
|
1095
|
+
* Fridays. API returns a formatted version of this string, which may cause
|
|
1096
|
+
* Terraform drift if a unformatted value is used.
|
|
1037
1097
|
*/
|
|
1038
1098
|
fri?: string;
|
|
1039
1099
|
/**
|
|
1040
|
-
*
|
|
1041
|
-
* from 00:00-24:00
|
|
1042
|
-
* Mondays.
|
|
1100
|
+
* Specify the time intervals when the rule is active on Mondays, in the increasing
|
|
1101
|
+
* order from 00:00-24:00(capped at maximum of 6 time splits). If this parameter
|
|
1102
|
+
* omitted, the rule is deactivated on Mondays. API returns a formatted version of
|
|
1103
|
+
* this string, which may cause Terraform drift if a unformatted value is used.
|
|
1043
1104
|
*/
|
|
1044
1105
|
mon?: string;
|
|
1045
1106
|
/**
|
|
1046
|
-
*
|
|
1047
|
-
* order from 00:00-24:00. If this parameter
|
|
1048
|
-
* deactivated on Saturdays.
|
|
1107
|
+
* Specify the time intervals when the rule is active on Saturdays, in the
|
|
1108
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1109
|
+
* deactivated on Saturdays. API returns a formatted version of this string, which
|
|
1110
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1049
1111
|
*/
|
|
1050
1112
|
sat?: string;
|
|
1051
1113
|
/**
|
|
1052
|
-
*
|
|
1053
|
-
* from 00:00-24:00. If this parameter
|
|
1054
|
-
* Sundays.
|
|
1114
|
+
* Specify the time intervals when the rule is active on Sundays, in the increasing
|
|
1115
|
+
* order from 00:00-24:00. If this parameter omitted, the rule is deactivated on
|
|
1116
|
+
* Sundays. API returns a formatted version of this string, which may cause
|
|
1117
|
+
* Terraform drift if a unformatted value is used.
|
|
1055
1118
|
*/
|
|
1056
1119
|
sun?: string;
|
|
1057
1120
|
/**
|
|
1058
|
-
*
|
|
1059
|
-
* order from 00:00-24:00. If this parameter
|
|
1060
|
-
* deactivated on Thursdays.
|
|
1121
|
+
* Specify the time intervals when the rule is active on Thursdays, in the
|
|
1122
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1123
|
+
* deactivated on Thursdays. API returns a formatted version of this string, which
|
|
1124
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1061
1125
|
*/
|
|
1062
1126
|
thu?: string;
|
|
1063
1127
|
/**
|
|
1064
|
-
*
|
|
1128
|
+
* Specify the time zone for rule evaluation. When a
|
|
1065
1129
|
* [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)
|
|
1066
|
-
* is provided, Gateway
|
|
1067
|
-
* parameter is omitted,
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
* center.
|
|
1130
|
+
* is provided, Gateway always uses the current time for that time zone. When this
|
|
1131
|
+
* parameter is omitted, Gateway uses the time zone determined from the user's IP
|
|
1132
|
+
* address. Colo time zone is used when the user's IP address does not resolve to a
|
|
1133
|
+
* location.
|
|
1071
1134
|
*/
|
|
1072
1135
|
time_zone?: string;
|
|
1073
1136
|
/**
|
|
1074
|
-
*
|
|
1075
|
-
* from 00:00-24:00. If this parameter
|
|
1076
|
-
* Tuesdays.
|
|
1137
|
+
* Specify the time intervals when the rule is active on Tuesdays, in the
|
|
1138
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1139
|
+
* deactivated on Tuesdays. API returns a formatted version of this string, which
|
|
1140
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1077
1141
|
*/
|
|
1078
1142
|
tue?: string;
|
|
1079
1143
|
/**
|
|
1080
|
-
*
|
|
1081
|
-
* order from 00:00-24:00. If this parameter
|
|
1082
|
-
* deactivated on Wednesdays.
|
|
1144
|
+
* Specify the time intervals when the rule is active on Wednesdays, in the
|
|
1145
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1146
|
+
* deactivated on Wednesdays. API returns a formatted version of this string, which
|
|
1147
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1083
1148
|
*/
|
|
1084
1149
|
wed?: string;
|
|
1085
1150
|
}
|
|
1086
1151
|
/**
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1152
|
+
* Defines the schedule for activating DNS policies. Settable only for `dns` and
|
|
1153
|
+
* `dns_resolver` rules.
|
|
1089
1154
|
*/
|
|
1090
1155
|
export interface ScheduleParam {
|
|
1091
1156
|
/**
|
|
1092
|
-
*
|
|
1093
|
-
* from 00:00-24:00. If this parameter
|
|
1094
|
-
* Fridays.
|
|
1157
|
+
* Specify the time intervals when the rule is active on Fridays, in the increasing
|
|
1158
|
+
* order from 00:00-24:00. If this parameter omitted, the rule is deactivated on
|
|
1159
|
+
* Fridays. API returns a formatted version of this string, which may cause
|
|
1160
|
+
* Terraform drift if a unformatted value is used.
|
|
1095
1161
|
*/
|
|
1096
1162
|
fri?: string;
|
|
1097
1163
|
/**
|
|
1098
|
-
*
|
|
1099
|
-
* from 00:00-24:00
|
|
1100
|
-
* Mondays.
|
|
1164
|
+
* Specify the time intervals when the rule is active on Mondays, in the increasing
|
|
1165
|
+
* order from 00:00-24:00(capped at maximum of 6 time splits). If this parameter
|
|
1166
|
+
* omitted, the rule is deactivated on Mondays. API returns a formatted version of
|
|
1167
|
+
* this string, which may cause Terraform drift if a unformatted value is used.
|
|
1101
1168
|
*/
|
|
1102
1169
|
mon?: string;
|
|
1103
1170
|
/**
|
|
1104
|
-
*
|
|
1105
|
-
* order from 00:00-24:00. If this parameter
|
|
1106
|
-
* deactivated on Saturdays.
|
|
1171
|
+
* Specify the time intervals when the rule is active on Saturdays, in the
|
|
1172
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1173
|
+
* deactivated on Saturdays. API returns a formatted version of this string, which
|
|
1174
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1107
1175
|
*/
|
|
1108
1176
|
sat?: string;
|
|
1109
1177
|
/**
|
|
1110
|
-
*
|
|
1111
|
-
* from 00:00-24:00. If this parameter
|
|
1112
|
-
* Sundays.
|
|
1178
|
+
* Specify the time intervals when the rule is active on Sundays, in the increasing
|
|
1179
|
+
* order from 00:00-24:00. If this parameter omitted, the rule is deactivated on
|
|
1180
|
+
* Sundays. API returns a formatted version of this string, which may cause
|
|
1181
|
+
* Terraform drift if a unformatted value is used.
|
|
1113
1182
|
*/
|
|
1114
1183
|
sun?: string;
|
|
1115
1184
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
* order from 00:00-24:00. If this parameter
|
|
1118
|
-
* deactivated on Thursdays.
|
|
1185
|
+
* Specify the time intervals when the rule is active on Thursdays, in the
|
|
1186
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1187
|
+
* deactivated on Thursdays. API returns a formatted version of this string, which
|
|
1188
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1119
1189
|
*/
|
|
1120
1190
|
thu?: string;
|
|
1121
1191
|
/**
|
|
1122
|
-
*
|
|
1192
|
+
* Specify the time zone for rule evaluation. When a
|
|
1123
1193
|
* [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)
|
|
1124
|
-
* is provided, Gateway
|
|
1125
|
-
* parameter is omitted,
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1128
|
-
* center.
|
|
1194
|
+
* is provided, Gateway always uses the current time for that time zone. When this
|
|
1195
|
+
* parameter is omitted, Gateway uses the time zone determined from the user's IP
|
|
1196
|
+
* address. Colo time zone is used when the user's IP address does not resolve to a
|
|
1197
|
+
* location.
|
|
1129
1198
|
*/
|
|
1130
1199
|
time_zone?: string;
|
|
1131
1200
|
/**
|
|
1132
|
-
*
|
|
1133
|
-
* from 00:00-24:00. If this parameter
|
|
1134
|
-
* Tuesdays.
|
|
1201
|
+
* Specify the time intervals when the rule is active on Tuesdays, in the
|
|
1202
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1203
|
+
* deactivated on Tuesdays. API returns a formatted version of this string, which
|
|
1204
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1135
1205
|
*/
|
|
1136
1206
|
tue?: string;
|
|
1137
1207
|
/**
|
|
1138
|
-
*
|
|
1139
|
-
* order from 00:00-24:00. If this parameter
|
|
1140
|
-
* deactivated on Wednesdays.
|
|
1208
|
+
* Specify the time intervals when the rule is active on Wednesdays, in the
|
|
1209
|
+
* increasing order from 00:00-24:00. If this parameter omitted, the rule is
|
|
1210
|
+
* deactivated on Wednesdays. API returns a formatted version of this string, which
|
|
1211
|
+
* may cause Terraform drift if a unformatted value is used.
|
|
1141
1212
|
*/
|
|
1142
1213
|
wed?: string;
|
|
1143
1214
|
}
|
|
@@ -1148,93 +1219,95 @@ export interface RuleCreateParams {
|
|
|
1148
1219
|
*/
|
|
1149
1220
|
account_id: string;
|
|
1150
1221
|
/**
|
|
1151
|
-
* Body param:
|
|
1152
|
-
* device posture expressions
|
|
1222
|
+
* Body param: Specify the action to perform when the associated traffic, identity,
|
|
1223
|
+
* and device posture expressions either absent or evaluate to `true`.
|
|
1153
1224
|
*/
|
|
1154
1225
|
action: 'on' | 'off' | 'allow' | 'block' | 'scan' | 'noscan' | 'safesearch' | 'ytrestricted' | 'isolate' | 'noisolate' | 'override' | 'l4_override' | 'egress' | 'resolve' | 'quarantine' | 'redirect';
|
|
1155
1226
|
/**
|
|
1156
|
-
* Body param:
|
|
1227
|
+
* Body param: Specify the rule name.
|
|
1157
1228
|
*/
|
|
1158
1229
|
name: string;
|
|
1159
1230
|
/**
|
|
1160
|
-
* Body param:
|
|
1231
|
+
* Body param: Specify the rule description.
|
|
1161
1232
|
*/
|
|
1162
1233
|
description?: string;
|
|
1163
1234
|
/**
|
|
1164
|
-
* Body param:
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1167
|
-
*
|
|
1235
|
+
* Body param: Specify the wirefilter expression used for device posture check. The
|
|
1236
|
+
* API automatically formats and sanitizes expressions before storing them. To
|
|
1237
|
+
* prevent Terraform state drift, use the formatted expression returned in the API
|
|
1238
|
+
* response.
|
|
1168
1239
|
*/
|
|
1169
1240
|
device_posture?: string;
|
|
1170
1241
|
/**
|
|
1171
|
-
* Body param:
|
|
1242
|
+
* Body param: Specify whether the rule is enabled.
|
|
1172
1243
|
*/
|
|
1173
1244
|
enabled?: boolean;
|
|
1174
1245
|
/**
|
|
1175
|
-
* Body param:
|
|
1176
|
-
* Takes precedence over the policy's `schedule` configuration, if any.
|
|
1177
|
-
*
|
|
1178
|
-
* This does not apply to HTTP or network policies.
|
|
1246
|
+
* Body param: Defines the expiration time stamp and default duration of a DNS
|
|
1247
|
+
* policy. Takes precedence over the policy's `schedule` configuration, if any.
|
|
1248
|
+
* This does not apply to HTTP or network policies. Settable only for `dns` rules.
|
|
1179
1249
|
*/
|
|
1180
1250
|
expiration?: RuleCreateParams.Expiration | null;
|
|
1181
1251
|
/**
|
|
1182
|
-
* Body param:
|
|
1183
|
-
* posture expressions.
|
|
1252
|
+
* Body param: Specify the protocol or layer to evaluate the traffic, identity, and
|
|
1253
|
+
* device posture expressions.
|
|
1184
1254
|
*/
|
|
1185
1255
|
filters?: Array<GatewayFilterParam>;
|
|
1186
1256
|
/**
|
|
1187
|
-
* Body param:
|
|
1188
|
-
* automatically formats and sanitizes
|
|
1189
|
-
*
|
|
1257
|
+
* Body param: Specify the wirefilter expression used for identity matching. The
|
|
1258
|
+
* API automatically formats and sanitizes expressions before storing them. To
|
|
1259
|
+
* prevent Terraform state drift, use the formatted expression returned in the API
|
|
1260
|
+
* response.
|
|
1190
1261
|
*/
|
|
1191
1262
|
identity?: string;
|
|
1192
1263
|
/**
|
|
1193
|
-
* Body param:
|
|
1194
|
-
*
|
|
1195
|
-
*
|
|
1264
|
+
* Body param: Set the order of your rules. Lower values indicate higher
|
|
1265
|
+
* precedence. At each processing phase, evaluate applicable rules in ascending
|
|
1266
|
+
* order of this value. Refer to
|
|
1196
1267
|
* [Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
|
|
1197
|
-
*
|
|
1268
|
+
* to manage precedence via Terraform.
|
|
1198
1269
|
*/
|
|
1199
1270
|
precedence?: number;
|
|
1200
1271
|
/**
|
|
1201
|
-
* Body param:
|
|
1272
|
+
* Body param: Set settings related to this rule. Each setting is only valid for
|
|
1273
|
+
* specific rule types and can only be used with the appropriate selectors. If
|
|
1274
|
+
* Terraform drift is observed in these setting values, verify that the setting is
|
|
1275
|
+
* supported for the given rule type and that the API response reflects the
|
|
1276
|
+
* requested value. If the API response returns sanitized or modified values that
|
|
1277
|
+
* differ from the request, use the API-provided values in Terraform to ensure
|
|
1278
|
+
* consistency.
|
|
1202
1279
|
*/
|
|
1203
1280
|
rule_settings?: RuleSettingParam;
|
|
1204
1281
|
/**
|
|
1205
|
-
* Body param:
|
|
1206
|
-
*
|
|
1282
|
+
* Body param: Defines the schedule for activating DNS policies. Settable only for
|
|
1283
|
+
* `dns` and `dns_resolver` rules.
|
|
1207
1284
|
*/
|
|
1208
1285
|
schedule?: ScheduleParam | null;
|
|
1209
1286
|
/**
|
|
1210
|
-
* Body param:
|
|
1211
|
-
* automatically formats and sanitizes
|
|
1212
|
-
*
|
|
1287
|
+
* Body param: Specify the wirefilter expression used for traffic matching. The API
|
|
1288
|
+
* automatically formats and sanitizes expressions before storing them. To prevent
|
|
1289
|
+
* Terraform state drift, use the formatted expression returned in the API
|
|
1290
|
+
* response.
|
|
1213
1291
|
*/
|
|
1214
1292
|
traffic?: string;
|
|
1215
1293
|
}
|
|
1216
1294
|
export declare namespace RuleCreateParams {
|
|
1217
1295
|
/**
|
|
1218
|
-
*
|
|
1219
|
-
* over the policy's `schedule` configuration, if any.
|
|
1220
|
-
*
|
|
1221
|
-
* This does not apply to HTTP or network policies.
|
|
1296
|
+
* Defines the expiration time stamp and default duration of a DNS policy. Takes
|
|
1297
|
+
* precedence over the policy's `schedule` configuration, if any. This does not
|
|
1298
|
+
* apply to HTTP or network policies. Settable only for `dns` rules.
|
|
1222
1299
|
*/
|
|
1223
1300
|
interface Expiration {
|
|
1224
1301
|
/**
|
|
1225
|
-
*
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
1229
|
-
*
|
|
1230
|
-
*
|
|
1231
|
-
* Policies with an expiration do not consider the timezone of clients they are
|
|
1232
|
-
* applied to, and expire "globally" at the point given by their `expires_at`
|
|
1233
|
-
* value.
|
|
1302
|
+
* Show the timestamp when the policy expires and stops applying. The value must
|
|
1303
|
+
* follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets
|
|
1304
|
+
* but converts them to the equivalent UTC+00:00 value and returns timestamps with
|
|
1305
|
+
* a trailing Z. Expiration policies ignore client timezones and expire globally at
|
|
1306
|
+
* the specified expires_at time.
|
|
1234
1307
|
*/
|
|
1235
1308
|
expires_at: string;
|
|
1236
1309
|
/**
|
|
1237
|
-
*
|
|
1310
|
+
* Defines the default duration a policy active in minutes. Must set in order to
|
|
1238
1311
|
* use the `reset_expiration` endpoint on this rule.
|
|
1239
1312
|
*/
|
|
1240
1313
|
duration?: number;
|
|
@@ -1246,93 +1319,95 @@ export interface RuleUpdateParams {
|
|
|
1246
1319
|
*/
|
|
1247
1320
|
account_id: string;
|
|
1248
1321
|
/**
|
|
1249
|
-
* Body param:
|
|
1250
|
-
* device posture expressions
|
|
1322
|
+
* Body param: Specify the action to perform when the associated traffic, identity,
|
|
1323
|
+
* and device posture expressions either absent or evaluate to `true`.
|
|
1251
1324
|
*/
|
|
1252
1325
|
action: 'on' | 'off' | 'allow' | 'block' | 'scan' | 'noscan' | 'safesearch' | 'ytrestricted' | 'isolate' | 'noisolate' | 'override' | 'l4_override' | 'egress' | 'resolve' | 'quarantine' | 'redirect';
|
|
1253
1326
|
/**
|
|
1254
|
-
* Body param:
|
|
1327
|
+
* Body param: Specify the rule name.
|
|
1255
1328
|
*/
|
|
1256
1329
|
name: string;
|
|
1257
1330
|
/**
|
|
1258
|
-
* Body param:
|
|
1331
|
+
* Body param: Specify the rule description.
|
|
1259
1332
|
*/
|
|
1260
1333
|
description?: string;
|
|
1261
1334
|
/**
|
|
1262
|
-
* Body param:
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1265
|
-
*
|
|
1335
|
+
* Body param: Specify the wirefilter expression used for device posture check. The
|
|
1336
|
+
* API automatically formats and sanitizes expressions before storing them. To
|
|
1337
|
+
* prevent Terraform state drift, use the formatted expression returned in the API
|
|
1338
|
+
* response.
|
|
1266
1339
|
*/
|
|
1267
1340
|
device_posture?: string;
|
|
1268
1341
|
/**
|
|
1269
|
-
* Body param:
|
|
1342
|
+
* Body param: Specify whether the rule is enabled.
|
|
1270
1343
|
*/
|
|
1271
1344
|
enabled?: boolean;
|
|
1272
1345
|
/**
|
|
1273
|
-
* Body param:
|
|
1274
|
-
* Takes precedence over the policy's `schedule` configuration, if any.
|
|
1275
|
-
*
|
|
1276
|
-
* This does not apply to HTTP or network policies.
|
|
1346
|
+
* Body param: Defines the expiration time stamp and default duration of a DNS
|
|
1347
|
+
* policy. Takes precedence over the policy's `schedule` configuration, if any.
|
|
1348
|
+
* This does not apply to HTTP or network policies. Settable only for `dns` rules.
|
|
1277
1349
|
*/
|
|
1278
1350
|
expiration?: RuleUpdateParams.Expiration | null;
|
|
1279
1351
|
/**
|
|
1280
|
-
* Body param:
|
|
1281
|
-
* posture expressions.
|
|
1352
|
+
* Body param: Specify the protocol or layer to evaluate the traffic, identity, and
|
|
1353
|
+
* device posture expressions.
|
|
1282
1354
|
*/
|
|
1283
1355
|
filters?: Array<GatewayFilterParam>;
|
|
1284
1356
|
/**
|
|
1285
|
-
* Body param:
|
|
1286
|
-
* automatically formats and sanitizes
|
|
1287
|
-
*
|
|
1357
|
+
* Body param: Specify the wirefilter expression used for identity matching. The
|
|
1358
|
+
* API automatically formats and sanitizes expressions before storing them. To
|
|
1359
|
+
* prevent Terraform state drift, use the formatted expression returned in the API
|
|
1360
|
+
* response.
|
|
1288
1361
|
*/
|
|
1289
1362
|
identity?: string;
|
|
1290
1363
|
/**
|
|
1291
|
-
* Body param:
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1364
|
+
* Body param: Set the order of your rules. Lower values indicate higher
|
|
1365
|
+
* precedence. At each processing phase, evaluate applicable rules in ascending
|
|
1366
|
+
* order of this value. Refer to
|
|
1294
1367
|
* [Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform)
|
|
1295
|
-
*
|
|
1368
|
+
* to manage precedence via Terraform.
|
|
1296
1369
|
*/
|
|
1297
1370
|
precedence?: number;
|
|
1298
1371
|
/**
|
|
1299
|
-
* Body param:
|
|
1372
|
+
* Body param: Set settings related to this rule. Each setting is only valid for
|
|
1373
|
+
* specific rule types and can only be used with the appropriate selectors. If
|
|
1374
|
+
* Terraform drift is observed in these setting values, verify that the setting is
|
|
1375
|
+
* supported for the given rule type and that the API response reflects the
|
|
1376
|
+
* requested value. If the API response returns sanitized or modified values that
|
|
1377
|
+
* differ from the request, use the API-provided values in Terraform to ensure
|
|
1378
|
+
* consistency.
|
|
1300
1379
|
*/
|
|
1301
1380
|
rule_settings?: RuleSettingParam;
|
|
1302
1381
|
/**
|
|
1303
|
-
* Body param:
|
|
1304
|
-
*
|
|
1382
|
+
* Body param: Defines the schedule for activating DNS policies. Settable only for
|
|
1383
|
+
* `dns` and `dns_resolver` rules.
|
|
1305
1384
|
*/
|
|
1306
1385
|
schedule?: ScheduleParam | null;
|
|
1307
1386
|
/**
|
|
1308
|
-
* Body param:
|
|
1309
|
-
* automatically formats and sanitizes
|
|
1310
|
-
*
|
|
1387
|
+
* Body param: Specify the wirefilter expression used for traffic matching. The API
|
|
1388
|
+
* automatically formats and sanitizes expressions before storing them. To prevent
|
|
1389
|
+
* Terraform state drift, use the formatted expression returned in the API
|
|
1390
|
+
* response.
|
|
1311
1391
|
*/
|
|
1312
1392
|
traffic?: string;
|
|
1313
1393
|
}
|
|
1314
1394
|
export declare namespace RuleUpdateParams {
|
|
1315
1395
|
/**
|
|
1316
|
-
*
|
|
1317
|
-
* over the policy's `schedule` configuration, if any.
|
|
1318
|
-
*
|
|
1319
|
-
* This does not apply to HTTP or network policies.
|
|
1396
|
+
* Defines the expiration time stamp and default duration of a DNS policy. Takes
|
|
1397
|
+
* precedence over the policy's `schedule` configuration, if any. This does not
|
|
1398
|
+
* apply to HTTP or network policies. Settable only for `dns` rules.
|
|
1320
1399
|
*/
|
|
1321
1400
|
interface Expiration {
|
|
1322
1401
|
/**
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1325
|
-
*
|
|
1326
|
-
*
|
|
1327
|
-
*
|
|
1328
|
-
*
|
|
1329
|
-
* Policies with an expiration do not consider the timezone of clients they are
|
|
1330
|
-
* applied to, and expire "globally" at the point given by their `expires_at`
|
|
1331
|
-
* value.
|
|
1402
|
+
* Show the timestamp when the policy expires and stops applying. The value must
|
|
1403
|
+
* follow RFC 3339 and include a UTC offset. The system accepts non-zero offsets
|
|
1404
|
+
* but converts them to the equivalent UTC+00:00 value and returns timestamps with
|
|
1405
|
+
* a trailing Z. Expiration policies ignore client timezones and expire globally at
|
|
1406
|
+
* the specified expires_at time.
|
|
1332
1407
|
*/
|
|
1333
1408
|
expires_at: string;
|
|
1334
1409
|
/**
|
|
1335
|
-
*
|
|
1410
|
+
* Defines the default duration a policy active in minutes. Must set in order to
|
|
1336
1411
|
* use the `reset_expiration` endpoint on this rule.
|
|
1337
1412
|
*/
|
|
1338
1413
|
duration?: number;
|