Purpose
Purpose
Prerequisites
Prerequisites
- Access to a Cloudflare account with administrative privileges.
- At least one domain (zone) added to your Cloudflare account.
- Access to the requiredย accountย andย zone.
- Permission to create:
- API Tokens, or
- Access legacy Global API Key
- Secure storage for the generated credentials
Supported Versions
Supported Versions
Authentication
Authentication
๐น Option 1: API Token (Recommended)
๐น Option 1: API Token (Recommended)
- Uses aย scoped API Token
- Providesย least-privilege access
- Preferred by customers and recommended by Cloudflare
๐น Option 2: Email + Global API Key (Legacy)
๐น Option 2: Email + Global API Key (Legacy)
- Uses:
- Cloudflareย account email
- Global API Key
- Account ID
- Providesย full account-level access
- Should only be used if API Token is not feasible
Uses:- Cloudflareย account email
- Global API Key
- Account ID
- Providesย full account-level access
- Should only be used if API Token is not feasible
Required Parameters
๐ Cloudflare Integration Guide
This guide outlines the process of retrieving key credentials from your Cloudflare dashboard for integration with external tools and APIs. Method 1: Generate API Token (Recommended) Method 2: Generate Global API Key (Legacy)Method 1 - Generate API Token Setup steps
To generate an API Token in the Cloudflare Platform for integrating with AirMDR, follow these steps:Sign In to Cloudflare
- Go to Cloudflare dashboard.
- Enter your login credentials and sign in.
Create API Token
- Click yourย profile iconย (top-right).
- Navigate toย My Profile โ API Tokens.
- Click Create Token.
- Choose
- Predefined template
(OR) - Custom Token
- Predefined template
- Configure:
- Token Name
- Permissions (Zone / Account level)
- Resources (specific zones or all zones)
- Clickย Continue to summary โ Create Token
Retrieve Cloudflare Account ID
- From the main dashboard, select any of your active domains.
- In the left-hand sidebar, scroll down and click Overview (if not already selected).
- In the right-side panel (under โAPIโ section), locate your Account ID.
- Click Copy to save it.
Retrieve Cloudflare Zone ID (Optional)
- From the Overview tab of your selected domain (zone).
- Scroll down to the section titled API or Zone ID.
- Locate the Zone ID and click Copy.
The Zone ID uniquely identifies your domain within Cloudflare.Email the API Token, Cloudflare Account ID and Cloudflare Zone ID to AirMDR
or
Self configure Cloudflare in the AirMDR Integrations Dashboard.
Method 2: Generate Global API Key (Legacy) Setup steps
To generate an Global API key in the Cloudflare Platform for integrating with AirMDR, follow these steps:Sign In to Cloudflare
- Go to Cloudflare dashboard.
- Enter your login credentials and sign in.
Retrieve Your Authentication Email
It will appear in the top-right corner of the dashboard once youโre logged in.This email is used along with your API key when authenticating API requests.
- Log in to the Cloudflare dashboard.
- Click yourย profile iconย in the top-right corner.
- Open yourย profile settings.
- Note the email address associated with the account.
Use only this value as theย Authentication Emailย when AirMDR requires legacy Global API Key authentication
Retrieve the Global API Key (Authentication API Key)
- From the dashboard, click your profile icon in the top-right corner.
- Select My Profile โ Go to the API Tokens tab.
- Under API Keysย section, locate Global API Key and click View.
- Enter your password to confirm.
- Click Copy to store the key securely.
The Global API Key grants full account access.
Retrieve Cloudflare Account ID
- From the main dashboard, select any of your active domains.
- In the left-hand sidebar, scroll down and click Overview (if not already selected).
- In the right-side panel (under โAPIโ section), locate your Account ID.
- Click Copy to save it.
Retrieve Cloudflare Zone ID (Optional)
- From the Overview tab of your selected domain (zone).
- Scroll down to the section titled API or Zone ID.
- Locate the Zone ID and click Copy.
The Zone ID uniquely identifies your domain within Cloudflare.Email the Global API key, Authentication Email, Cloudflare Account ID, and Cloudflare Zone ID to AirMDR
or
Self configure Cloudflare in the AirMDR Integrations Dashboard.
Credential Path Reference
Test Cloudflare Authentication
Sample cURL Requests to Test Cloudflare Authentication - with GLOBAL_API_KEY
Sample cURL Requests to Test Cloudflare Authentication - with GLOBAL_API_KEY
YOUR_ACCOUNT_IDwith your actual Cloudflare Account IDYOUR_EMAIL@example.comwith your Cloudflare account emailYOUR_GLOBAL_API_KEYwith your Global API Key.
Sample Response
Sample Response
Sample cURL Requests to Test Cloudflare Authentication - with API_TOKEN
Sample cURL Requests to Test Cloudflare Authentication - with API_TOKEN
YOUR_API_TOKENwith your actual Cloudflare API Token
Sample Response
Sample Response
Configure Cloudflare in the AirMDR Integrations Dashboard
- Navigate to AirMDR, provide the credentials, and click Login
- Navigate to the AirMDR Integrations Dashboard in the left navigation pane and select Integrations.
- Use the search option, enter the keyword โCloudflareโ, select the Connections tab, and click Add New Connection.
- Enter an unique name to the Instance (e.g.,
your org name-Cloudflare) and brief Description to easily identify the user connection by AirMDR. - Enter the generated Authentication API Key (Global API Key), and retrieved Authentication Email, Cloudflare Account ID, Cloudflare Zone ID and Expiry (optional) in the Authentication Details field params, and click Save.
Skills Provided by this Integration with required Permissions
Read-Only Skills
Read-Only Skills
Read and Write Skills
Read and Write Skills
Additional Information
๐งฐ Error Handling
๐งฐ Error Handling
๐ Monitoring & Logs
๐ Monitoring & Logs
๐ Security & Access Best Practices
๐ Security & Access Best Practices
๐ Support & Maintenance
๐ Support & Maintenance
๐ Data Flow & Security
๐ Data Flow & Security
โ
Summary
โ Summary
- API Token + Account ID + Zone ID
- Email + Global API Key + Account ID + Zone ID

