Back to source list
Official
Premium
Cloudflare
The CloudQuery Cloudflare plugin pulls configuration out of Cloudflare resources and loads it into any supported CloudQuery destination
Publisher
cloudquery
Latest version
v11.1.6
Type
Source
Platforms
Date Published
Overview #
Cloudflare Source Plugin
The CloudQuery Cloudflare plugin pulls configuration out of Cloudflare resources and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).
Authentication #
In order to fetch information from Cloudflare,
cloudquery needs to be authenticated. There are a few options for authentication:- Via an API token (preferred)
- Via an API email and key
The plugin requires only read permissions. To start, Cloudflare has a
read all resources API token template that will grant CloudQuery the necessary permissions to fetch information from Cloudflare. As necessary, those permissions can be refined and modified further to meet your needs.Query Examples #
Find all zones with dev_mode enabled #
SELECT id, account_id, host_name, name, original_ns FROM cloudflare_zones WHERE dev_mode = true;
Find all DNS records #
SELECT id, account_id, zone_id, name, type FROM cloudflare_dns_records;
Configuration #
Cloudflare Source Plugin Configuration Reference
Example #
This example syncs from Cloudflare to a Postgres destination, using in-line
api_token authentication (instead of the CLOUDFLARE_API_TOKEN environment variable). The (top level) source spec section is described in the Source Spec Reference.kind: source
# Common source-plugin configuration
spec:
name: cloudflare
path: cloudquery/cloudflare
registry: cloudquery
version: "v11.1.6"
tables: ["*"]
destinations: ["postgresql"]
# Cloudflare specific configuration
# Learn more about the configuration options at https://cql.ink/cloudflare_source
spec:
# required, if api_email and api_key are not set
api_token: "${CLOUDFLARE_API_TOKEN}"
# required, if api_token is not set
# api_email: ""
# required, if api_token is not set
# api_key: ""
# Optional parameters
# accounts: []
# zones: []
Cloudflare Spec #
This is the (nested) spec used by the Cloudflare source plugin.
api_token(string, optional. Default: empty): An API token to access Cloudflare resources. This can also be set with theCLOUDFLARE_API_TOKENenvironment variable. An API token authentication is preferred over API email and key authentication. Ifapi_tokenis specified,api_emailandapi_keyshouldn't be specified.api_email(string, optional. Default: empty): API email to access Cloudflare resources. Ifapi_emailis specified,api_keyshould also be specified. This can also be set with theCLOUDFLARE_EMAILenvironment variable. Ifapi_emailis used,api_tokenshouldn't be specified.api_key(string, optional. Default: empty): API key to access Cloudflare resources. Ifapi_keyis used,api_emailshould also be specified. This can also be set with theCLOUDFLARE_API_KEYenvironment variable. Ifapi_keyis used,api_tokenshouldn't be specified.accounts([]string, optional. Default: empty): List of accounts to target. If empty, all available accounts will be targeted.zones([]string, optional. Default: empty): List of zones to target. If empty, all available zones will be targeted.concurrency(integer, optional, default:10000): A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.scheduler(string, optional, default:dfs): The scheduler to use when determining the priority of resources to sync. Supported values aredfs(depth-first search),round-robin,shuffleandshuffle-queue.For more information about this, see performance tuning.